Struct ShapeSet

pub struct ShapeSet { /* private fields */ }

A set of Shape values, which correctly handles the relationship between newtype and tuple shapes.

Example

let shape_set = ShapeSet::new(vec![Shape::Tuple]);

// This is correct, because all newtypes are single-field tuples.
assert!(shape_set.contains(&Shape::Newtype));

Implementations

impl ShapeSet

pub fn new(items: impl IntoIterator<Item = Shape>) -> Self

Create a new ShapeSet which includes the specified items.

Exampe

let shape_set = ShapeSet::new(vec![Shape::Named, Shape::Newtype]);
assert!(shape_set.contains(&Shape::Newtype));

pub fn insert_all(&mut self)

Insert all possible shapes into the set.

This is equivalent to calling insert with every value of Shape.

Example

let mut shape_set = ShapeSet::default();
shape_set.insert_all();
assert!(shape_set.contains(&Shape::Named));

pub fn insert(&mut self, shape: Shape)

Insert a shape into the set, so that the set will match that shape

pub fn is_empty(&self) -> bool

Whether this set is empty.

pub fn contains(&self, fields: &impl AsShape) -> bool

Check if a fields container’s shape is in this set.

pub fn check(&self, fields: &impl AsShape) -> Result<()>

Check if a field container’s shape is in this set of shapes, and produce an Error if it does not.

Trait Implementations

impl Clone for ShapeSet

fn clone(&self) -> ShapeSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeSet

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

Formats the value using the given formatter.

impl Default for ShapeSet

fn default() -> ShapeSet

Returns the “default value” for a type.

impl Display for ShapeSet

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

Formats the value using the given formatter.

impl FromIterator<Shape> for ShapeSet

fn from_iter<T: IntoIterator<Item = Shape>>(iter: T) -> Self

Creates a value from an iterator.