Struct pschema_rs::shape::shex::Cardinality

pub struct Cardinality { /* private fields */ }

The Cardinality type represents the shape and bounds of a set or sequence.

Properties:

• shape: The shape property is a Shape enum that represents the shape of the cardinality. It could be one of the following:
• min: min is a property of the Cardinality struct that represents the minimum number of elements allowed in the associated Shape. It is of type Bound, which is likely an enum that can represent either a specific integer value or an unbounded value (e.g. `Bound::Finite
• max: max is a property of the Cardinality struct that represents the maximum number of elements that can be contained within the shape defined by the shape property. It is of type Bound, which is an enum that can either be Finite(usize) to represent a specific number

Implementations

impl Cardinality

This is an implementation of the Cardinality struct. It defines two methods: new and get_shape.

pub fn new(shape: Shape, min: Bound, max: Bound) -> Self

This is a constructor function that creates a new instance of a struct with a given shape, minimum bound, and maximum bound.

Arguments:

• shape: The shape parameter is of type Shape and represents the geometric shape of an object. It could be a circle, rectangle, triangle, or any other shape that can be defined mathematically.
• min: min is a parameter of type Bound that represents the minimum bounds of the shape. It is used in the constructor of a struct to create a new instance of the struct with the specified shape and minimum and maximum bounds.
• max: max is a parameter of type Bound that represents the maximum bounds of the shape. It is used in the new function to create a new instance of the Self struct.

Returns:

The new function is returning an instance of the struct that it is defined in. The type of the returned value is Self, which in this case refers to the struct that the new function is defined in.

pub fn get_shape(self) -> Shape

This Rust function returns the shape of an object.

Returns:

A Shape object is being returned.

Trait Implementations

impl Clone for Cardinality

fn clone(&self) -> Cardinality

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cardinality

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

Formats the value using the given formatter.

impl From<Cardinality> for Shape

This implementation allows a Cardinality struct to be converted into a Shape enum variant using the From trait. It creates a new Shape::Cardinality variant with the Cardinality struct wrapped in a Box. This allows for more flexibility in working with Shape objects, as a Cardinality can be treated as a Shape in certain contexts.

fn from(value: Cardinality) -> Self

Converts to this type from the input type.

impl PartialEq<Cardinality> for Cardinality

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

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

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 StructuralPartialEq for Cardinality