Struct Field

pub struct Field { /* private fields */ }

The metadata and inner Fields of a field.

Implementations

impl Field

pub const fn empty() -> Self

Create a new empty field metadata.

pub fn new(doc: impl Into<String>, fields: Option<Fields>) -> Self

Create a new field metadata from parts.

pub fn doc(&self) -> &str

Get a shared reference to the documentation metadata of this field.

pub fn doc_mut(&mut self) -> &mut String

Get a mutable reference to the documentation metadata of this field.

pub fn with_doc(&mut self, doc: impl Into<String>) -> &mut Self

Set the documentation metadata of this field.

let mut field = Field::empty();

assert_eq!(field.doc(), "");

field.with_doc("some meta");

assert_eq!(field.doc(), "some meta");

pub fn fields(&self) -> Option<&Fields>

Get a shared reference to the inner fields of this field, if it has any.

pub fn fields_mut(&mut self) -> Option<&mut Fields>

Get a mutable reference to the inner fields of this field, if it has any.

pub fn has_fields(&self) -> bool

Return whether this field has inner fields.

let mut field = Field::empty();

assert!(!field.has_fields());

field.with_fields(Some(Fields::default()));

assert!(field.has_fields());

pub fn with_fields(&mut self, fields: Option<Fields>) -> &mut Self

Set the inner fields of this field.

let mut field = Field::empty();

assert!(!field.has_fields());

field.with_fields(Some(Fields::default()));

assert!(field.has_fields());

field.with_fields(None);
  
assert!(!field.has_fields());

pub fn build_fields(&mut self, builder: impl FnOnce(&mut Fields)) -> &mut Self

Ergonomic shortcut for building some inner fields.

let mut field = Field::empty();

field.build_fields(|fields| {
    fields.field("inner field");
});

assert_eq!(field.fields().map(|fields| fields.contains("inner field")), Some(true));

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Default for Field

fn default() -> Field

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Field

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Field

fn eq(&self, other: &Field) -> 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 Field

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Field

impl StructuralPartialEq for Field