Struct emojic::emojis::Family

pub struct Family {
    pub parents: OneOrTwo,
    pub children: OneOrTwo,
}

Represents the genders of an entire family with parents and children.

A Family consists of parents and children, each either a single or two persons as expressed by the OneOrTwo struct.

E.g.:

• one parent & one child: 👨‍👦
• two parents & one child: 👨‍👨‍👦
• one parent & two children: 👩‍👧‍👦
• and so on…

To get a Family value, it is recommended to use any of the From impls e.g.:

// From<(Gender,Gender)>
assert_eq!(
    Family {
        parents: OneOrTwo::One(Gender::Male),
        children: OneOrTwo::One(Gender::Male),
    },
    (Gender::Male,Gender::Male).into()
);
// From<(Pair,Pair)>
assert_eq!(
    Family {
        parents: OneOrTwo::Two(Pair::Males),
        children: OneOrTwo::Two(Pair::Males),
    },
    (Pair::Males,Pair::Males).into()
);

Or use the with_children composer of Gender and Pair:

// Gender::with_children
assert_eq!(
    Family {
        parents: OneOrTwo::One(Gender::Male),
        children: OneOrTwo::One(Gender::Male),
    },
    Gender::Male.with_children(Gender::Male)
);
// Pair::with_children
assert_eq!(
    Family {
        parents: OneOrTwo::Two(Pair::Males),
        children: OneOrTwo::Two(Pair::Males),
    },
    Pair::Males.with_children(Pair::Males)
);

Fields

parents: OneOrTwo

children: OneOrTwo

Trait Implementations

impl Clone for Family

fn clone(&self) -> Family

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Family

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

Formats the value using the given formatter.

impl<A: Into<OneOrTwo>, B: Into<OneOrTwo>> From<(A, B)> for Family

fn from((parents, children): (A, B)) -> Self

Converts to this type from the input type.

impl Hash for Family

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,

Feeds a slice of this type into the given Hasher.

impl Ord for Family

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Family> for Family

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<Family> for Family

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Family

impl Eq for Family

impl StructuralEq for Family

impl StructuralPartialEq for Family