Struct Ingredient

pub struct Ingredient { /* private fields */ }

Object that represents an Ingredient of the Cocktail data base.

Description

An ingredient represents the elements that are contained by a Cocktail’s recipe. This object only represents the ingredients as a model for being included in individual recipes. Hence no information related to quantities or any other information that joins an ingredient with a recipe is included as an attribute of this object.

Implementations

impl Ingredient

pub fn parse( id: Option<&str>, name: &str, category: &str, description: Option<&str>, ) -> Result<Self, Box<dyn Error>>

Builds a new Ingredient performing checks over the input parameters.

Description

The implementation checks that the given name value meets the following requirements:

• The length of the name doesn’t exceeds 40 characters.
• The name is composed of alphanumeric characters plus the special character %.
• The name does not contain the following forbidden characters: [, <, >, ;, {, }, ].

Arguments

• name will be used as Ingredient::name.
• category will be used as Ingredient::category. Use IngCategory::Other when no needed.
• desc will be used as Ingredient::desc. Pass None when no description was provided along the Ingredient’s name.

Return

A new Ingredient when the input parameters comply the format rules, an error otherwise that contains a message with information about the broken format rule.

pub fn name(&self) -> &str

Get the Ingredient’s name.

pub fn category(&self) -> IngCategory

Get the Ingredient’s category as a value of the Enum IngCategory.

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

Get the description of the Ingredient. Wrapped to allow empty descriptions.

pub fn id(&self) -> Option<Uuid>

Get the ingredient’s ID in the Cocktail data base.

pub fn set_id(&mut self, id: Uuid)

Set the ID of the ingredient in the Cocktail data base.

Trait Implementations

impl Clone for Ingredient

fn clone(&self) -> Ingredient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ingredient

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ingredient

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Ingredient

fn eq(&self, other: &Self) -> 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 Serialize for Ingredient

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for Ingredient

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the [ToSchema::schema].