Skip to main content

Field

Struct Field 

Source
pub struct Field<'ast, State> { /* private fields */ }
Expand description

A Nickel record field being constructed

Implementations§

Source§

impl<'ast, A> Field<'ast, A>

Source

pub fn doc(self, doc: impl AsRef<str>) -> Self

Attach documentation metadata to the field

Source

pub fn some_doc(self, some_doc: Option<impl AsRef<str>>) -> Self

Attach documentation metadata to the field, optionally

Source

pub fn optional(self, opt: bool) -> Self

Mark the field as optional or not, depending on opt

Source

pub fn not_exported(self, not_exported: bool) -> Self

Mark the field as not_exported or not, depending on the argument

Source

pub fn contract(self, contract: impl Into<Type<'ast>>) -> Self

Attach a contract to the field

Source

pub fn contracts<I>(self, contracts: I) -> Self
where I: IntoIterator<Item = Type<'ast>>,

Attach multiple contracts to the field

Source

pub fn types(self, typ: impl Into<Type<'ast>>) -> Self

Attach a type annotation to the field

Source

pub fn priority(self, priority: MergePriority) -> Self

Set the field’s merge priority

Source

pub fn metadata(self, metadata: FieldMetadata<'ast>) -> Self

Set the field’s metadata all at once

Source§

impl<'ast> Field<'ast, Incomplete>

Source

pub fn path<I, It>(path: It) -> Self
where I: AsRef<str>, It: IntoIterator<Item = I>,

Construct an incomplete Field at a given path

Source

pub fn name(name: impl AsRef<str>) -> Self

Construct an incomplete Field with a given name

Source

pub fn no_value(self) -> Field<'ast, Complete<'ast>>

Finalize the Field without setting a value

Source

pub fn value(self, value: impl Into<Ast<'ast>>) -> Field<'ast, Complete<'ast>>

Finalize the Field by setting its value

Source§

impl<'ast> Field<'ast, Complete<'ast>>

Source

pub fn attach(self, alloc: &'ast AstAlloc, record: Record<'ast>) -> Record<'ast>

Attach a finalized Field to a Record

Source§

impl<'ast> Field<'ast, Record<'ast>>

Source

pub fn no_value(self, alloc: &'ast AstAlloc) -> Record<'ast>

Finalize the Field without setting a value

Source

pub fn value( self, alloc: &'ast AstAlloc, value: impl Into<Ast<'ast>>, ) -> Record<'ast>

Finalize the Field by setting its a value

Trait Implementations§

Source§

impl<'ast, State: Debug> Debug for Field<'ast, State>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'ast, State> Freeze for Field<'ast, State>
where State: Freeze,

§

impl<'ast, State> RefUnwindSafe for Field<'ast, State>
where State: RefUnwindSafe,

§

impl<'ast, State> Send for Field<'ast, State>
where State: Send,

§

impl<'ast, State> Sync for Field<'ast, State>
where State: Sync,

§

impl<'ast, State> Unpin for Field<'ast, State>
where State: Unpin,

§

impl<'ast, State> UnsafeUnpin for Field<'ast, State>
where State: UnsafeUnpin,

§

impl<'ast, State> UnwindSafe for Field<'ast, State>
where State: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, U> ExactFrom<T> for U
where U: TryFrom<T>,

Source§

fn exact_from(value: T) -> U

Source§

impl<T, U> ExactInto<U> for T
where U: ExactFrom<T>,

Source§

fn exact_into(self) -> U

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> OverflowingInto<U> for T
where U: OverflowingFrom<T>,

Source§

impl<T, U> RoundingInto<U> for T
where U: RoundingFrom<T>,

Source§

impl<T, U> SaturatingInto<U> for T
where U: SaturatingFrom<T>,

Source§

impl<T> ToDebugString for T
where T: Debug,

Source§

fn to_debug_string(&self) -> String

Returns the String produced by Ts Debug implementation.

§Examples
use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");
Source§

impl<T, U> TryConvert<'_, T> for U
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

Source§

fn try_convert( _: &AstAlloc, from: T, ) -> Result<U, <U as TryConvert<'_, T>>::Error>

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U> WrappingInto<U> for T
where U: WrappingFrom<T>,

Source§

fn wrapping_into(self) -> U