Value

darkfi::zk::halo2

Struct Value 

pub struct Value<V> {
    inner: Option<V>,
}
Expand description

A value that might exist within a circuit.

This behaves like Option<V> but differs in two key ways:

  • It does not expose the enum cases, or provide an Option::unwrap equivalent. This helps to ensure that unwitnessed values correctly propagate.
  • It provides pass-through implementations of common traits such as Add and Mul, for improved usability.

Fields§

§inner: Option<V>

Implementations§

§

impl<V> Value<V>

pub const fn unknown() -> Value<V>

Constructs an unwitnessed value.

pub const fn known(value: V) -> Value<V>

Constructs a known value.

§Examples
use halo2_proofs::circuit::Value;

let v = Value::known(37);

pub fn as_ref(&self) -> Value<&V>

Converts from &Value<V> to Value<&V>.

pub fn as_mut(&mut self) -> Value<&mut V>

Converts from &mut Value<V> to Value<&mut V>.

pub fn assert_if_known<F>(&self, f: F)
where F: FnOnce(&V) -> bool,

Enforces an assertion on the contained value, if known.

The assertion is ignored if self is Value::unknown(). Do not try to enforce circuit constraints with this method!

§Panics

Panics if f returns false.

pub fn error_if_known_and<F>(&self, f: F) -> Result<(), Error>
where F: FnOnce(&V) -> bool,

Checks the contained value for an error condition, if known.

The error check is ignored if self is Value::unknown(). Do not try to enforce circuit constraints with this method!

pub fn map<W, F>(self, f: F) -> Value<W>
where F: FnOnce(V) -> W,

Maps a Value<V> to Value<W> by applying a function to the contained value.

pub fn and_then<W, F>(self, f: F) -> Value<W>
where F: FnOnce(V) -> Value<W>,

Returns Value::unknown() if the value is Value::unknown(), otherwise calls f with the wrapped value and returns the result.

pub fn zip<W>(self, other: Value<W>) -> Value<(V, W)>

Zips self with another Value.

If self is Value::known(s) and other is Value::known(o), this method returns Value::known((s, o)). Otherwise, Value::unknown() is returned.

§

impl<V, W> Value<(V, W)>

pub fn unzip(self) -> (Value<V>, Value<W>)

Unzips a value containing a tuple of two values.

If self is Value::known((a, b)), this method returns (Value::known(a), Value::known(b)). Otherwise, (Value::unknown(), Value::unknown())` is returned.

§

impl<V> Value<&V>

pub fn copied(self) -> Value<V>
where V: Copy,

Maps a Value<&V> to a Value<V> by copying the contents of the value.

pub fn cloned(self) -> Value<V>
where V: Clone,

Maps a Value<&V> to a Value<V> by cloning the contents of the value.

§

impl<V> Value<&mut V>

pub fn copied(self) -> Value<V>
where V: Copy,

Maps a Value<&mut V> to a Value<V> by copying the contents of the value.

pub fn cloned(self) -> Value<V>
where V: Clone,

Maps a Value<&mut V> to a Value<V> by cloning the contents of the value.

§

impl<V, const LEN: usize> Value<[V; LEN]>
where V: Copy,

pub fn transpose_array(self) -> [Value<V>; LEN]

Transposes a Value<[V; LEN]> into a [Value<V>; LEN].

Value::unknown() will be mapped to [Value::unknown(); LEN].

§

impl<V, I> Value<I>
where I: IntoIterator<Item = V>, <I as IntoIterator>::IntoIter: ExactSizeIterator,

pub fn transpose_vec(self, length: usize) -> Vec<Value<V>>

Transposes a Value<impl IntoIterator<Item = V>> into a Vec<Value<V>>.

Value::unknown() will be mapped to vec![Value::unknown(); length].

§Panics

Panics if self is Value::known(values) and values.len() != length.

§

impl<V> Value<V>

pub fn to_field<F>(&self) -> Value<Assigned<F>>
where F: Field, Assigned<F>: for<'v> From<&'v V>,

Returns the field element corresponding to this value.

pub fn into_field<F>(self) -> Value<Assigned<F>>
where F: Field, V: Into<Assigned<F>>,

Returns the field element corresponding to this value.

pub fn double<F>(&self) -> Value<Assigned<F>>
where F: Field, V: Borrow<Assigned<F>>,

Doubles this field element.

§Examples

If you have a Value<F: Field>, convert it to Value<Assigned<F>> first:

use halo2_proofs::{circuit::Value, plonk::Assigned};

let v = Value::known(F::from(2));
let v: Value<Assigned<F>> = v.into();
v.double();

pub fn square<F>(&self) -> Value<Assigned<F>>
where F: Field, V: Borrow<Assigned<F>>,

Squares this field element.

pub fn cube<F>(&self) -> Value<Assigned<F>>
where F: Field, V: Borrow<Assigned<F>>,

Cubes this field element.

pub fn invert<F>(&self) -> Value<Assigned<F>>
where F: Field, V: Borrow<Assigned<F>>,

Inverts this assigned value (taking the inverse of zero to be zero).

§

impl<F> Value<Assigned<F>>
where F: Field,

pub fn evaluate(self) -> Value<F>

Evaluates this value directly, performing an unbatched inversion if necessary.

If the denominator is zero, the returned value is zero.

Trait Implementations§

§

impl<V, O> Add<&Value<V>> for Value<V>
where V: for<'v> Add<&'v V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the + operator.
§

fn add(self, rhs: &Value<V>) -> <Value<V> as Add<&Value<V>>>::Output

Performs the + operation. Read more
§

impl<F> Add<F> for Value<&Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the + operator.
§

fn add(self, rhs: F) -> <Value<&Assigned<F>> as Add<F>>::Output

Performs the + operation. Read more
§

impl<F> Add<F> for Value<Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the + operator.
§

fn add(self, rhs: F) -> <Value<Assigned<F>> as Add<F>>::Output

Performs the + operation. Read more
§

impl<V, O> Add<Value<&V>> for Value<V>
where V: for<'v> Add<&'v V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the + operator.
§

fn add(self, rhs: Value<&V>) -> <Value<V> as Add<Value<&V>>>::Output

Performs the + operation. Read more
§

impl<F> Add<Value<F>> for Value<&Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the + operator.
§

fn add(self, rhs: Value<F>) -> <Value<&Assigned<F>> as Add<Value<F>>>::Output

Performs the + operation. Read more
§

impl<F> Add<Value<F>> for Value<Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the + operator.
§

fn add(self, rhs: Value<F>) -> <Value<Assigned<F>> as Add<Value<F>>>::Output

Performs the + operation. Read more
§

impl<V, O> Add<Value<V>> for &Value<V>
where &'v V: for<'v> Add<V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the + operator.
§

fn add(self, rhs: Value<V>) -> <&Value<V> as Add<Value<V>>>::Output

Performs the + operation. Read more
§

impl<V, O> Add<Value<V>> for Value<&V>
where &'v V: for<'v> Add<V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the + operator.
§

fn add(self, rhs: Value<V>) -> <Value<&V> as Add<Value<V>>>::Output

Performs the + operation. Read more
§

impl<V, O> Add for &Value<V>
where &'v V: for<'v> Add<Output = O>,

§

type Output = Value<O>

The resulting type after applying the + operator.
§

fn add(self, rhs: &Value<V>) -> <&Value<V> as Add>::Output

Performs the + operation. Read more
§

impl<V, O> Add for Value<V>
where V: Add<Output = O>,

§

type Output = Value<O>

The resulting type after applying the + operator.
§

fn add(self, rhs: Value<V>) -> <Value<V> as Add>::Output

Performs the + operation. Read more
§

impl<V> Clone for Value<V>
where V: Clone,

§

fn clone(&self) -> Value<V>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl<V> Debug for Value<V>
where V: Debug,

§

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

Formats the value using the given formatter. Read more
§

impl<V> Default for Value<V>

§

fn default() -> Value<V>

Returns the “default value” for a type. Read more
§

impl<F> FieldValue<F> for Value<F>
where F: Field,

§

fn value(&self) -> Value<&F>

Returns the value of this type.
§

impl<F> From<Value<F>> for Value<Assigned<F>>
where F: Field,

§

fn from(value: Value<F>) -> Value<Assigned<F>>

Converts to this type from the input type.
§

impl<A, V> FromIterator<Value<A>> for Value<V>
where V: FromIterator<A>,

§

fn from_iter<I>(iter: I) -> Value<V>
where I: IntoIterator<Item = Value<A>>,

Takes each element in the Iterator: if it is Value::unknown(), no further elements are taken, and the Value::unknown() is returned. Should no Value::unknown() occur, a container of type V containing the values of each Value is returned.

§

impl<V, O> Mul<&Value<V>> for Value<V>
where V: for<'v> Mul<&'v V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the * operator.
§

fn mul(self, rhs: &Value<V>) -> <Value<V> as Mul<&Value<V>>>::Output

Performs the * operation. Read more
§

impl<F> Mul<F> for Value<&Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the * operator.
§

fn mul(self, rhs: F) -> <Value<&Assigned<F>> as Mul<F>>::Output

Performs the * operation. Read more
§

impl<F> Mul<F> for Value<Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the * operator.
§

fn mul(self, rhs: F) -> <Value<Assigned<F>> as Mul<F>>::Output

Performs the * operation. Read more
§

impl<V, O> Mul<Value<&V>> for Value<V>
where V: for<'v> Mul<&'v V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the * operator.
§

fn mul(self, rhs: Value<&V>) -> <Value<V> as Mul<Value<&V>>>::Output

Performs the * operation. Read more
§

impl<F> Mul<Value<F>> for Value<&Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the * operator.
§

fn mul(self, rhs: Value<F>) -> <Value<&Assigned<F>> as Mul<Value<F>>>::Output

Performs the * operation. Read more
§

impl<F> Mul<Value<F>> for Value<Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the * operator.
§

fn mul(self, rhs: Value<F>) -> <Value<Assigned<F>> as Mul<Value<F>>>::Output

Performs the * operation. Read more
§

impl<V, O> Mul<Value<V>> for &Value<V>
where &'v V: for<'v> Mul<V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the * operator.
§

fn mul(self, rhs: Value<V>) -> <&Value<V> as Mul<Value<V>>>::Output

Performs the * operation. Read more
§

impl<V, O> Mul<Value<V>> for Value<&V>
where &'v V: for<'v> Mul<V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the * operator.
§

fn mul(self, rhs: Value<V>) -> <Value<&V> as Mul<Value<V>>>::Output

Performs the * operation. Read more
§

impl<V, O> Mul for &Value<V>
where &'v V: for<'v> Mul<Output = O>,

§

type Output = Value<O>

The resulting type after applying the * operator.
§

fn mul(self, rhs: &Value<V>) -> <&Value<V> as Mul>::Output

Performs the * operation. Read more
§

impl<V, O> Mul for Value<V>
where V: Mul<Output = O>,

§

type Output = Value<O>

The resulting type after applying the * operator.
§

fn mul(self, rhs: Value<V>) -> <Value<V> as Mul>::Output

Performs the * operation. Read more
§

impl<V> Neg for Value<V>
where V: Neg,

§

type Output = Value<<V as Neg>::Output>

The resulting type after applying the - operator.
§

fn neg(self) -> <Value<V> as Neg>::Output

Performs the unary - operation. Read more
§

impl<V, O> Sub<&Value<V>> for Value<V>
where V: for<'v> Sub<&'v V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the - operator.
§

fn sub(self, rhs: &Value<V>) -> <Value<V> as Sub<&Value<V>>>::Output

Performs the - operation. Read more
§

impl<F> Sub<F> for Value<&Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the - operator.
§

fn sub(self, rhs: F) -> <Value<&Assigned<F>> as Sub<F>>::Output

Performs the - operation. Read more
§

impl<F> Sub<F> for Value<Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the - operator.
§

fn sub(self, rhs: F) -> <Value<Assigned<F>> as Sub<F>>::Output

Performs the - operation. Read more
§

impl<V, O> Sub<Value<&V>> for Value<V>
where V: for<'v> Sub<&'v V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the - operator.
§

fn sub(self, rhs: Value<&V>) -> <Value<V> as Sub<Value<&V>>>::Output

Performs the - operation. Read more
§

impl<F> Sub<Value<F>> for Value<&Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the - operator.
§

fn sub(self, rhs: Value<F>) -> <Value<&Assigned<F>> as Sub<Value<F>>>::Output

Performs the - operation. Read more
§

impl<F> Sub<Value<F>> for Value<Assigned<F>>
where F: Field,

§

type Output = Value<Assigned<F>>

The resulting type after applying the - operator.
§

fn sub(self, rhs: Value<F>) -> <Value<Assigned<F>> as Sub<Value<F>>>::Output

Performs the - operation. Read more
§

impl<V, O> Sub<Value<V>> for &Value<V>
where &'v V: for<'v> Sub<V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the - operator.
§

fn sub(self, rhs: Value<V>) -> <&Value<V> as Sub<Value<V>>>::Output

Performs the - operation. Read more
§

impl<V, O> Sub<Value<V>> for Value<&V>
where &'v V: for<'v> Sub<V, Output = O>,

§

type Output = Value<O>

The resulting type after applying the - operator.
§

fn sub(self, rhs: Value<V>) -> <Value<&V> as Sub<Value<V>>>::Output

Performs the - operation. Read more
§

impl<V, O> Sub for &Value<V>
where &'v V: for<'v> Sub<Output = O>,

§

type Output = Value<O>

The resulting type after applying the - operator.
§

fn sub(self, rhs: &Value<V>) -> <&Value<V> as Sub>::Output

Performs the - operation. Read more
§

impl<V, O> Sub for Value<V>
where V: Sub<Output = O>,

§

type Output = Value<O>

The resulting type after applying the - operator.
§

fn sub(self, rhs: Value<V>) -> <Value<V> as Sub>::Output

Performs the - operation. Read more
Source§

impl TryFrom<HeapVar> for Value<[Base; 32]>

Source§

type Error = Error

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

fn try_from(value: HeapVar) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<HeapVar> for Value<[Base; 255]>

Source§

type Error = Error

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

fn try_from(value: HeapVar) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<HeapVar> for Value<u32>

Source§

type Error = Error

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

fn try_from(value: HeapVar) -> Result<Self, Self::Error>

Performs the conversion.
§

impl<V> Copy for Value<V>
where V: Copy,

Auto Trait Implementations§

§

impl<V> Freeze for Value<V>
where V: Freeze,

§

impl<V> RefUnwindSafe for Value<V>
where V: RefUnwindSafe,

§

impl<V> Send for Value<V>
where V: Send,

§

impl<V> Sync for Value<V>
where V: Sync,

§

impl<V> Unpin for Value<V>
where V: Unpin,

§

impl<V> UnwindSafe for Value<V>
where V: 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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

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

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
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.
§

impl<T> Upcastable for T
where T: Any + Send + Sync + 'static,

§

fn upcast_any_ref(&self) -> &(dyn Any + 'static)

upcast ref
§

fn upcast_any_mut(&mut self) -> &mut (dyn Any + 'static)

upcast mut ref
§

fn upcast_any_box(self: Box<T>) -> Box<dyn Any>

upcast boxed dyn
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,