Enum derive_builder_core::BuilderPattern

pub enum BuilderPattern {
    Owned,
    Mutable,
    Immutable,
}

Controls the signature of a setter method, more specifically how self is passed and returned.

It can also be generalized to methods with different parameter sets and return types, e.g. the build() method.

Variants

Owned

E.g. fn bar(self, bar: Bar) -> Self.

Mutable

E.g. fn bar(&mut self, bar: Bar) -> &mut Self.

Immutable

E.g. fn bar(&self, bar: Bar) -> Self.

Note:

• Needs to clone in order to return an updated instance of Self.
• There is a great chance that the Rust compiler (LLVM) will optimize chained clone calls away in release mode. Therefore this turns out not to be as bad as it sounds.

Methods

impl BuilderPattern

pub fn requires_clone(&self) -> bool

Returns true if this style of builder needs to be able to clone its fields during the build method.

Trait Implementations

impl Eq for BuilderPattern

impl PartialEq<BuilderPattern> for BuilderPattern

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

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

#[must_use]

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

This method tests for !=.

impl Clone for BuilderPattern

fn clone(&self) -> BuilderPattern

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BuilderPattern

impl Default for BuilderPattern

Defaults to Mutable.

fn default() -> BuilderPattern

Returns the "default value" for a type.

impl Debug for BuilderPattern

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

Formats the value using the given formatter.

impl FromMeta for BuilderPattern

fn from_list(__outer: &[NestedMeta]) -> Result<Self>

Create an instance from a list of nested meta items.

fn from_string(lit: &str) -> Result<Self>

Create an instance from a string literal in a value position.

fn from_nested_meta(item: &NestedMeta) -> Result<Self, Error>

fn from_meta(item: &Meta) -> Result<Self, Error>

Create an instance from a syn::Meta by dispatching to the format-appropriate trait function. This generally should not be overridden by implementers.

fn from_word() -> Result<Self, Error>

Create an instance from the presence of the word in the attribute with no additional options specified.

fn from_value(value: &Lit) -> Result<Self, Error>

Create an instance from a literal value of either foo = "bar" or foo("bar"). This dispatches to the appropriate method based on the type of literal encountered, and generally should not be overridden by implementers.

fn from_char(value: char) -> Result<Self, Error>

Create an instance from a char literal in a value position.

fn from_bool(value: bool) -> Result<Self, Error>

Create an instance from a bool literal in a value position.