Enum snarkvm_wasm::nonnative::NonNativeFieldVar [−][src]
pub enum NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField, { Constant(TargetField), Var(AllocatedNonNativeFieldVar<TargetField, BaseField>), }
Expand description
A gadget for representing non-native (TargetField
) field elements over the constraint field (BaseField
).
Variants
Constant
Var(AllocatedNonNativeFieldVar<TargetField, BaseField>)
Allocated gadget
Implementations
impl<TargetField, BaseField> NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
Get the value of the gadget.
pub fn from_boolean<CS>(
cs: CS,
boolean: Boolean
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn from_boolean<CS>(
cs: CS,
boolean: Boolean
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Constructs Self
from a Boolean
: if boolean
is true
, this outputs
one
, else it outputs zero
.
pub fn is_eq<CS>(
&self,
cs: CS,
other: &NonNativeFieldVar<TargetField, BaseField>
) -> Result<Boolean, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn is_eq<CS>(
&self,
cs: CS,
other: &NonNativeFieldVar<TargetField, BaseField>
) -> Result<Boolean, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Determine if two NonNativeFieldVar
instances are equal.
pub fn mul_without_reduce<CS>(
&self,
cs: CS,
other: &NonNativeFieldVar<TargetField, BaseField>
) -> Result<NonNativeFieldMulResultVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn mul_without_reduce<CS>(
&self,
cs: CS,
other: &NonNativeFieldVar<TargetField, BaseField>
) -> Result<NonNativeFieldMulResultVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
The mul_without_reduce
for NonNativeFieldVar
Trait Implementations
impl<TargetField, BaseField> AllocGadget<TargetField, BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> AllocGadget<TargetField, BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn alloc_constant<FN, T, CS>(
_cs: CS,
value_gen: FN
) -> Result<NonNativeFieldVar<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<NonNativeFieldVar<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<NonNativeFieldVar<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 NonNativeFieldVar<TargetField, BaseField> where
BaseField: Clone + PrimeField,
TargetField: Clone + PrimeField,
impl<TargetField, BaseField> Clone for NonNativeFieldVar<TargetField, BaseField> where
BaseField: Clone + PrimeField,
TargetField: Clone + PrimeField,
impl<TargetField, BaseField> CondSelectGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> CondSelectGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn conditionally_select<CS>(
cs: CS,
cond: &Boolean,
first: &NonNativeFieldVar<TargetField, BaseField>,
second: &NonNativeFieldVar<TargetField, BaseField>
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
impl<TargetField, BaseField> ConditionalEqGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> ConditionalEqGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn conditional_enforce_equal<CS>(
&self,
cs: CS,
other: &NonNativeFieldVar<TargetField, BaseField>,
condition: &Boolean
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<BaseField>,
impl<TargetField, BaseField> Debug for NonNativeFieldVar<TargetField, BaseField> where
BaseField: Debug + PrimeField,
TargetField: Debug + PrimeField,
impl<TargetField, BaseField> Debug for NonNativeFieldVar<TargetField, BaseField> where
BaseField: Debug + PrimeField,
TargetField: Debug + PrimeField,
impl<TargetField, BaseField> EqGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> EqGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn enforce_equal<CS>(
&self,
cs: CS,
other: &NonNativeFieldVar<TargetField, BaseField>
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<BaseField>,
fn is_eq<CS>(&self, _cs: CS, _other: &Self) -> Result<Boolean, SynthesisError> where
CS: ConstraintSystem<F>,
fn is_eq<CS>(&self, _cs: CS, _other: &Self) -> Result<Boolean, SynthesisError> where
CS: ConstraintSystem<F>,
Output a Boolean
value representing whether self.value() == other.value()
. Read more
impl<TargetField, BaseField> FieldGadget<TargetField, BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> FieldGadget<TargetField, BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
type Variable = AllocatedNonNativeFieldVar<TargetField, BaseField>
pub fn get_variable(
&self
) -> <NonNativeFieldVar<TargetField, BaseField> as FieldGadget<TargetField, BaseField>>::Variable
pub fn zero<CS>(
CS
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn one<CS>(
CS
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn negate<CS>(
&self,
cs: CS
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn conditionally_add_constant<CS>(
&self,
_cs: CS,
_bit: &Boolean,
_coeff: TargetField
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn add<CS>(
&self,
cs: CS,
other: &NonNativeFieldVar<TargetField, BaseField>
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn add_constant<CS>(
&self,
cs: CS,
other: &TargetField
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn sub<CS>(
&self,
cs: CS,
other: &NonNativeFieldVar<TargetField, BaseField>
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn mul<CS>(
&self,
cs: CS,
other: &NonNativeFieldVar<TargetField, BaseField>
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn mul_by_constant<CS>(
&self,
cs: CS,
other: &TargetField
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn inverse<CS>(
&self,
cs: CS
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
pub fn frobenius_map<CS>(
&self,
CS,
power: usize
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
fn add_in_place<CS>(
&mut self,
cs: CS,
other: &Self
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn double_in_place<CS>(&mut self, cs: CS) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn sub_in_place<CS>(
&mut self,
cs: CS,
other: &Self
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn negate_in_place<CS>(&mut self, cs: CS) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn mul_in_place<CS>(
&mut self,
cs: CS,
other: &Self
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn square_in_place<CS>(&mut self, cs: CS) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn mul_equals<CS>(
&self,
cs: CS,
other: &Self,
result: &Self
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>,
fn square_equals<CS>(&self, cs: CS, result: &Self) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>,
fn add_constant_in_place<CS>(
&mut self,
cs: CS,
other: &NativeF
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn sub_constant<CS>(&self, cs: CS, fe: &NativeF) -> Result<Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn sub_constant_in_place<CS>(
&mut self,
cs: CS,
other: &NativeF
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn mul_by_constant_in_place<CS>(
&mut self,
cs: CS,
other: &NativeF
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn frobenius_map_in_place<CS>(
&mut self,
cs: CS,
power: usize
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn pow<CS>(&self, cs: CS, bits: &[Boolean]) -> Result<Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn pow<CS>(&self, cs: CS, bits: &[Boolean]) -> Result<Self, SynthesisError> where
CS: ConstraintSystem<F>,
Accepts as input a list of bits which, when interpreted in big-endian form, are a scalar. Read more
fn pow_by_constant<CS, S>(&self, cs: CS, exp: S) -> Result<Self, SynthesisError> where
CS: ConstraintSystem<F>,
S: AsRef<[u64]>,
fn pow_by_constant<CS, S>(&self, cs: CS, exp: S) -> Result<Self, SynthesisError> where
CS: ConstraintSystem<F>,
S: AsRef<[u64]>,
Computes self^S
, where S is interpreted as an little-endian
u64-decomposition of an integer. Read more
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> Hash for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> Hash for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> NEqGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> NEqGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
pub fn enforce_not_equal<CS>(
&self,
cs: CS,
other: &NonNativeFieldVar<TargetField, BaseField>
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<BaseField>,
impl<TargetField, BaseField> PartialEq<NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> PartialEq<NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> ThreeBitCondNegLookupGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> ThreeBitCondNegLookupGadget<BaseField> for NonNativeFieldVar<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: &[<NonNativeFieldVar<TargetField, BaseField> as ThreeBitCondNegLookupGadget<BaseField>>::TableConstant]
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
impl<TargetField, BaseField> ToBitsBEGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> ToBitsBEGadget<BaseField> for NonNativeFieldVar<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 NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> ToBitsLEGadget<BaseField> for NonNativeFieldVar<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 NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> ToBytesGadget<BaseField> for NonNativeFieldVar<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<CS>(&self, cs: CS) -> Result<Vec<UInt8, Global>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
Outputs the unique byte decomposition of self
in little-endian
form.
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 NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
impl<TargetField, BaseField> TwoBitLookupGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
Uses two bits to perform a lookup into a table
b
is little-endian: b[0]
is LSB.
type TableConstant = TargetField
pub fn two_bit_lookup<CS>(
cs: CS,
bits: &[Boolean],
constants: &[<NonNativeFieldVar<TargetField, BaseField> as TwoBitLookupGadget<BaseField>>::TableConstant]
) -> Result<NonNativeFieldVar<TargetField, BaseField>, SynthesisError> where
CS: ConstraintSystem<BaseField>,
impl<TargetField, BaseField> Eq for NonNativeFieldVar<TargetField, BaseField> where
BaseField: PrimeField,
TargetField: PrimeField,
Auto Trait Implementations
impl<TargetField, BaseField> RefUnwindSafe for NonNativeFieldVar<TargetField, BaseField> where
BaseField: RefUnwindSafe,
TargetField: RefUnwindSafe,
impl<TargetField, BaseField> Send for NonNativeFieldVar<TargetField, BaseField>
impl<TargetField, BaseField> Sync for NonNativeFieldVar<TargetField, BaseField>
impl<TargetField, BaseField> Unpin for NonNativeFieldVar<TargetField, BaseField> where
BaseField: Unpin,
TargetField: Unpin,
impl<TargetField, BaseField> UnwindSafe for NonNativeFieldVar<TargetField, BaseField> where
BaseField: UnwindSafe,
TargetField: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<F, T> ConditionalOrEqualsGadget<F> for T where
T: ConditionalEqGadget<F> + CondSelectGadget<F>,
F: Field,
impl<F, T> ConditionalOrEqualsGadget<F> for T where
T: ConditionalEqGadget<F> + CondSelectGadget<F>,
F: Field,
pub fn conditional_enforce_equal_or<CS>(
cs: CS,
cond: &Boolean,
var: &T,
first: &T,
second: &T,
should_enforce: &Boolean
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>,
Compare self to key
and return true
if they are equal.
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
pub fn enforce_equal_or<CS>(
cs: CS,
cond: &Boolean,
var: &T,
first: &T,
second: &T
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>,
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