Struct Author

pub struct Author {
    pub shareable: Option<bool>,
    /* private fields */
}

Object that represents an Author of the Cocktail data base.

Description

Authors’ main role is defining recipes in the data base, and own them until they delete them or transfer the ownership. This object is a simple descriptor that includes some personal information of the authors.

All attributes are optional to allow using this struct as query object for the GET methods of the /author endpoint. Mandatory fields are defined in the description of each method of the endpoint.

Some restrictions over the struct’s members:

• Author::id must contain a valid Uuid. Strings are parsed to Uuid. The expected format is a 128-bit value, formatted as a hex string in five groups. The first 4 groups are randomly generated, and the fifth comes from a timestamp. However, clients can freely generate this ID using other combinations as long as the length and basic format rules are honored.
• Author::name and Author::surname shall have a minimum length of 2 and a maximum of 40 characters. These fields are allowed to repeat in the DB. Authors are identified in the DB by Author::id. Usernames are not required.
• Author::email is validated against the HTML5 regex.
• Author::description can’t exceed 255 characters length.
• Author::website must contain an url format (http://... or https://...).

Authors are given the choice to share or keep private their profiles. Activate Author::shareable to allow sharing the author’s profile to the main public. Private profiles are protected from non privileged clients of the API (with no API access token): only the Author::id and Author::name is given when a unprivileged client requests the data of an author to the API.

The constructor Author::default is given to generate a new author entry using a random funny name.

Prefer AuthorBuilder rather than Author::new to build a new Author instance.

Fields

shareable: Option<bool>

Decide whether an author profile can be shared to the public or not.

Implementations

impl Author

pub fn new( id: Option<String>, name: Option<String>, surname: Option<String>, email: Option<String>, shareable: Option<bool>, description: Option<String>, website: Option<String>, social_profiles: Option<&[SocialProfile]>, ) -> Result<Self, DataDomainError>

Constructor of the Author struct.

Descriptor

All fields are optional

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

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

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

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

pub fn shareable(&self) -> bool

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

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

pub fn social_profiles(&self) -> Option<&[SocialProfile]>

pub fn mute_private_data(&mut self)

pub fn enable_sharing(&mut self)

pub fn disable_sharing(&mut self)

pub fn update_from(&mut self, update: &Author)

Update the internal attributes using another Author object.

Description

This method takes as reference another Author object, and replaces the internal values, which are also present in the given reference, using the values from the reference. This method is meant to implement a PATCH logic.

Trait Implementations

impl Clone for Author

fn clone(&self) -> Author

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Author

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

Formats the value using the given formatter.

impl Default for Author

fn default() -> Self

Default constructor for Author.

Description

This constructor builds a new Author whose name is randomly generated using funny names and adjectives.

impl<'de> Deserialize<'de> for Author

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoParams for Author

fn into_params( parameter_in_provider: impl Fn() -> Option<ParameterIn>, ) -> Vec<Parameter>

Provide Vec of [openapi::path::Parameter]s to caller. The result is used in utoipa-gen library to provide OpenAPI parameter information for the endpoint using the parameters.

impl PartialEq for Author

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 Author

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 Author

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].

impl Validate for Author

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for Author

type Args = ()

fn validate_args(&self, args: Self::Args) -> Result<(), ValidationErrors>