Struct snarkvm_wasm::nonnative::AllocatedNonNativeFieldVar [−][src]
pub struct AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField, { pub limbs: Vec<FpGadget<BaseField>, Global>, pub num_of_additions_over_normal_form: BaseField, pub is_in_the_normal_form: bool, // some fields omitted }
Expand description
The allocated version of NonNativeFieldVar
(introduced below)
Fields
limbs: Vec<FpGadget<BaseField>, Global>
The limbs, each of which is a BaseField gadget.
num_of_additions_over_normal_form: BaseField
Number of additions done over this gadget, using which the gadget decides when to reduce.
is_in_the_normal_form: bool
Whether the limb representation is the normal form (using only the bits specified in the parameters, and the representation is strictly within the range of TargetField).
Implementations
impl<TargetField, BaseField> AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn limbs_to_value(
limbs: Vec<BaseField, Global>,
optimization_type: OptimizationType
) -> TargetField
pub fn limbs_to_value(
limbs: Vec<BaseField, Global>,
optimization_type: OptimizationType
) -> TargetField
Obtain the value of limbs
Obtain the value of a nonnative field element
pub fn constant<CS>(
cs: &mut CS,
value: TargetField
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn constant<CS>(
cs: &mut CS,
value: TargetField
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Obtain the nonnative field element of a constant value
pub fn one<CS>(
cs: &mut CS
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn one<CS>(
cs: &mut CS
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Obtain the nonnative field element of one
pub fn zero<CS>(
cs: &mut CS
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn zero<CS>(
cs: &mut CS
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Obtain the nonnative field element of zero
pub fn add<CS>(
&self,
cs: &mut CS,
other: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn add<CS>(
&self,
cs: &mut CS,
other: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Add a nonnative field element
pub fn add_constant<CS>(
&self,
cs: &mut CS,
other: &TargetField
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn add_constant<CS>(
&self,
cs: &mut CS,
other: &TargetField
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Add a constant
pub fn sub_without_reduce<CS>(
&self,
cs: &mut CS,
other: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn sub_without_reduce<CS>(
&self,
cs: &mut CS,
other: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Subtract a nonnative field element, without the final reduction step
pub fn sub<CS>(
&self,
cs: &mut CS,
other: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn sub<CS>(
&self,
cs: &mut CS,
other: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Subtract a nonnative field element
pub fn sub_constant<CS>(
&self,
cs: &mut CS,
other: &TargetField
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn sub_constant<CS>(
&self,
cs: &mut CS,
other: &TargetField
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Subtract a constant
pub fn mul<CS>(
&self,
cs: &mut CS,
other: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn mul<CS>(
&self,
cs: &mut CS,
other: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Multiply a nonnative field element
pub fn mul_constant<CS>(
&self,
cs: &mut CS,
other: &TargetField
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn mul_constant<CS>(
&self,
cs: &mut CS,
other: &TargetField
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Multiply a constant
pub fn negate<CS>(
&self,
cs: &mut CS
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn negate<CS>(
&self,
cs: &mut CS
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Compute the negate of a nonnative field element
pub fn inverse<CS>(
&self,
cs: &mut CS
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn inverse<CS>(
&self,
cs: &mut CS
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Compute the inverse of a nonnative field element
pub fn get_limbs_representations(
elem: &TargetField,
optimization_type: OptimizationType
) -> Result<Vec<BaseField, Global>, SynthesisError>
pub fn get_limbs_representations(
elem: &TargetField,
optimization_type: OptimizationType
) -> Result<Vec<BaseField, Global>, SynthesisError>
Convert a TargetField
element into limbs (not constraints)
This is an internal function that would be reused by a number of other functions
pub fn get_limbs_representations_from_big_integer(
elem: &<TargetField as PrimeField>::BigInteger,
optimization_type: OptimizationType
) -> Result<Vec<BaseField, Global>, SynthesisError>
pub fn get_limbs_representations_from_big_integer(
elem: &<TargetField as PrimeField>::BigInteger,
optimization_type: OptimizationType
) -> Result<Vec<BaseField, Global>, SynthesisError>
Obtain the limbs directly from a big int
pub fn mul_without_reduce<CS>(
&self,
cs: &mut CS,
other: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldMulResultVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn mul_without_reduce<CS>(
&self,
cs: &mut CS,
other: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldMulResultVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
For advanced use, multiply and output the intermediate representations (without reduction)
This intermediate representations can be added with each other, and they can later be reduced back to the NonNativeFieldVar
.
Trait Implementations
impl<TargetField, BaseField> AllocGadget<TargetField, BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> AllocGadget<TargetField, BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn alloc_constant<FN, T, CS>(
cs: CS,
value_gen: FN
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
T: Borrow<TargetField>,
FN: FnOnce() -> Result<T, SynthesisError>,
pub fn alloc<FN, T, CS>(
cs: CS,
value_gen: FN
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
T: Borrow<TargetField>,
FN: FnOnce() -> Result<T, SynthesisError>,
pub fn alloc_input<FN, T, CS>(
cs: CS,
value_gen: FN
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
T: Borrow<TargetField>,
FN: FnOnce() -> Result<T, SynthesisError>,
fn alloc_checked<Fn, T, CS>(cs: CS, f: Fn) -> Result<Self, SynthesisError> where
Fn: FnOnce() -> Result<T, SynthesisError>,
CS: ConstraintSystem<F>,
T: Borrow<V>,
fn alloc_input_checked<Fn, T, CS>(cs: CS, f: Fn) -> Result<Self, SynthesisError> where
Fn: FnOnce() -> Result<T, SynthesisError>,
CS: ConstraintSystem<F>,
T: Borrow<V>,
impl<TargetField, BaseField> Clone for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> Clone for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> CondSelectGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> CondSelectGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn conditionally_select<CS>(
cs: CS,
cond: &Boolean,
first: &AllocatedNonNativeFieldVar<TargetField, BaseField>,
second: &AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
impl<TargetField, BaseField> Debug for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: Debug + PrimeField,
TargetField: Debug + PrimeField,
impl<TargetField, BaseField> Debug for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: Debug + PrimeField,
TargetField: Debug + PrimeField,
impl<TargetField, BaseField> From<AllocatedNonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> From<AllocatedNonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn from(
other: AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> NonNativeFieldVar<TargetField, BaseField>
pub fn from(
other: AllocatedNonNativeFieldVar<TargetField, BaseField>
) -> NonNativeFieldVar<TargetField, BaseField>
Performs the conversion.
impl<TargetField, BaseField> ThreeBitCondNegLookupGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> ThreeBitCondNegLookupGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
type TableConstant = TargetField
pub fn three_bit_cond_neg_lookup<CS>(
cs: CS,
bits: &[Boolean],
b0b1: &Boolean,
constants: &[<AllocatedNonNativeFieldVar<TargetField, BaseField> as ThreeBitCondNegLookupGadget<BaseField>>::TableConstant]
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
impl<TargetField, BaseField> ToBitsBEGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> ToBitsBEGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn to_bits_be<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn to_bits_be_strict<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn to_bits_be_strict<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Additionally checks if the produced list of booleans is ‘valid’.
impl<TargetField, BaseField> ToBitsLEGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> ToBitsLEGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn to_bits_le<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn to_bits_le_strict<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn to_bits_le_strict<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Additionally checks if the produced list of booleans is ‘valid’.
impl<TargetField, BaseField> ToBytesGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> ToBytesGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn to_bytes<CS>(&self, cs: CS) -> Result<Vec<UInt8, Global>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn to_bytes_strict<CS>(
&self,
cs: CS
) -> Result<Vec<UInt8, Global>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn to_bytes_strict<CS>(
&self,
cs: CS
) -> Result<Vec<UInt8, Global>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Additionally checks if the produced list of booleans is ‘valid’.
impl<TargetField, BaseField> TwoBitLookupGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> TwoBitLookupGadget<BaseField> for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
type TableConstant = TargetField
pub fn two_bit_lookup<CS>(
cs: CS,
bits: &[Boolean],
constants: &[<AllocatedNonNativeFieldVar<TargetField, BaseField> as TwoBitLookupGadget<BaseField>>::TableConstant]
) -> Result<AllocatedNonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Auto Trait Implementations
impl<TargetField, BaseField> RefUnwindSafe for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: RefUnwindSafe,
TargetField: RefUnwindSafe,
impl<TargetField, BaseField> Send for AllocatedNonNativeFieldVar<TargetField, BaseField>
impl<TargetField, BaseField> Sync for AllocatedNonNativeFieldVar<TargetField, BaseField>
impl<TargetField, BaseField> Unpin for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: Unpin,
TargetField: Unpin,
impl<TargetField, BaseField> UnwindSafe for AllocatedNonNativeFieldVar<TargetField, BaseField> where
BaseField: UnwindSafe,
TargetField: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
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,
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
Causes self
to use its Octal
implementation when Debug
-formatted.
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
impl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
Pipes by value. This is generally the method you want to use. Read more
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,
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,
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,
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>,
R: 'a,
U: 'a + ?Sized,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
R: 'a,
U: 'a + ?Sized,
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>,
R: 'a,
U: 'a + ?Sized,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
R: 'a,
U: 'a + ?Sized,
Mutably borrows self
, then passes self.as_mut()
into the pipe
function. Read more
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,
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_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,
fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,
Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,
fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,
Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
Pipes a dereference into a function that cannot normally be called in suffix position. Read more
fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,
fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,
Pipes a mutable dereference into a function that cannot normally be called in suffix position. Read more
Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more
type Output = T
type Output = T
Should always be Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
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,
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
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,
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
Immutable access to the Deref::Target
of a value. Read more
Mutable access to the Deref::Target
of a value. Read more
Calls .tap()
only in debug builds, and is erased in release builds.
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
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. Read more
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
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. Read more
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
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. Read more
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
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. Read more
Provides immutable access for inspection. Read more
Calls tap
in debug builds, and does nothing in release builds.
Provides mutable access for modification. Read more
fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,
fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,
Calls tap_mut
in debug builds, and does nothing in release builds.
impl<T, U> TapAsRef<U> for T where
U: ?Sized,
impl<T, U> TapAsRef<U> for T where
U: ?Sized,
Provides immutable access to the reference for inspection.
fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,
fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,
Calls tap_ref
in debug builds, and does nothing in release builds.
fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the reference for modification.
fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
Calls tap_ref_mut
in debug builds, and does nothing in release builds.
impl<T, U> TapBorrow<U> for T where
U: ?Sized,
impl<T, U> TapBorrow<U> for T where
U: ?Sized,
fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
Provides immutable access to the borrow for inspection. Read more
fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
Calls tap_borrow
in debug builds, and does nothing in release builds.
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the borrow for modification.
fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Calls tap_borrow_mut
in debug builds, and does nothing in release
builds. Read more
Immutably dereferences self
for inspection.
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Calls tap_deref
in debug builds, and does nothing in release builds.
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Mutably dereferences self
for modification.
fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Calls tap_deref_mut
in debug builds, and does nothing in release
builds. Read more