Struct RockComposition 

pub struct RockComposition { /* private fields */ }

Implementations

impl RockComposition

pub fn with_label(label: impl AsRef<str>) -> Result<Self, RockTextError>

Creates a rock composition with a non-empty label and no mineral names.

Errors

Returns RockTextError::Empty when the trimmed label is empty.

pub fn with_mineral_names<I, S>( mineral_names: I, ) -> Result<Self, RockCompositionError>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Creates a rock composition from at least one non-empty mineral name.

Errors

Returns RockCompositionError::EmptyMineralName when any mineral name is empty. Returns RockCompositionError::NoMineralNames when no mineral names are supplied.

pub fn describe<I, S>( label: impl AsRef<str>, mineral_names: I, ) -> Result<Self, RockCompositionError>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Creates a labeled rock composition from a non-empty label and mineral list.

Errors

Returns RockCompositionError::EmptyLabel when the label is empty. Returns RockCompositionError::EmptyMineralName when any mineral name is empty. Returns RockCompositionError::NoMineralNames when no mineral names are supplied.

pub fn label(&self) -> Option<&str>

pub fn mineral_names(&self) -> &[String]

Trait Implementations

impl Clone for RockComposition

fn clone(&self) -> RockComposition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RockComposition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for RockComposition

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for RockComposition

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RockComposition

fn cmp(&self, other: &RockComposition) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RockComposition

fn eq(&self, other: &RockComposition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RockComposition

fn partial_cmp(&self, other: &RockComposition) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for RockComposition

impl StructuralPartialEq for RockComposition