Struct snarkvm_wasm::marlin_pc::MarlinKZG10[−][src]

pub struct MarlinKZG10<E> where
    E: PairingEngine,  { /* fields omitted */ }

Expand description

Polynomial commitment based on [KZG10], with degree enforcement, batching, and (optional) hiding property taken from [CHMMVW20, “Marlin”].

Degree bound enforcement requires that (at least one of) the points at which a committed polynomial is evaluated are from a distribution that is random conditioned on the polynomial. This is because degree bound enforcement relies on checking a polynomial identity at this point. More formally, the points must be sampled from an admissible query sampler, as detailed in [CHMMVW20].

Trait Implementations

impl<E> Clone for MarlinKZG10<E> where
    E: Clone + PairingEngine,

pub fn clone(&self) -> MarlinKZG10<E>

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl<E> Debug for MarlinKZG10<E> where
    E: Debug + PairingEngine,

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

Formats the value using the given formatter. Read more

impl<TargetCurve, BaseCurve, PG> PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr> for MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> where
    PG: PairingGadget<TargetCurve, <BaseCurve as PairingEngine>::Fr>,
    TargetCurve: PairingEngine,
    BaseCurve: PairingEngine,
    <TargetCurve as PairingEngine>::G1Affine: ToConstraintField<<BaseCurve as PairingEngine>::Fr>,
    <TargetCurve as PairingEngine>::G2Affine: ToConstraintField<<BaseCurve as PairingEngine>::Fr>,

type BatchLCProofVar = BatchLCProofVar<TargetCurve, BaseCurve, PG>

An allocated version of PC::BatchLCProof.

type CommitmentVar = CommitmentVar<TargetCurve, BaseCurve, PG>

An allocated version of PC::Commitment.

type LabeledCommitmentVar = LabeledCommitmentVar<TargetCurve, BaseCurve, PG>

An allocated version of LabeledCommitment<PC::Commitment>.

type PreparedCommitmentVar = PreparedCommitmentVar<TargetCurve, BaseCurve, PG>

An allocated version of PC::PreparedCommitment.

type PreparedLabeledCommitmentVar = PreparedLabeledCommitmentVar<TargetCurve, BaseCurve, PG>

A prepared, allocated version of LabeledCommitment<PC::Commitment>.

type PreparedVerifierKeyVar = PreparedVerifierKeyVar<TargetCurve, BaseCurve, PG>

An allocated version of PC::PreparedVerifierKey.

type ProofVar = ProofVar<TargetCurve, BaseCurve, PG>

An allocated version of PC::Proof.

type VerifierKeyVar = VerifierKeyVar<TargetCurve, BaseCurve, PG>

An allocated version of PC::VerifierKey.

pub fn batch_check_evaluations<CS>(
    cs: CS, 
    verification_key: &<MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> as PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr>>::VerifierKeyVar, 
    commitments: &[<MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> as PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr>>::LabeledCommitmentVar], 
    query_set: &QuerySetVar<<TargetCurve as PairingEngine>::Fr, <BaseCurve as PairingEngine>::Fr>, 
    evaluations: &EvaluationsVar<<TargetCurve as PairingEngine>::Fr, <BaseCurve as PairingEngine>::Fr>, 
    proofs: &[<MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> as PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr>>::ProofVar], 
    rand_data: &PCCheckRandomDataVar<<TargetCurve as PairingEngine>::Fr, <BaseCurve as PairingEngine>::Fr>
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<<BaseCurve as PairingEngine>::Fr>,

Add to ConstraintSystem<ConstraintF> new constraints that check that proof_i is a valid evaluation proof at point_i for the polynomial in commitment_i. Read more

pub fn prepared_check_combinations<CS>(
    cs: CS, 
    prepared_verification_key: &<MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> as PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr>>::PreparedVerifierKeyVar, 
    linear_combinations: &[LinearCombinationVar<<TargetCurve as PairingEngine>::Fr, <BaseCurve as PairingEngine>::Fr>], 
    prepared_commitments: &[<MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> as PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr>>::PreparedLabeledCommitmentVar], 
    query_set: &QuerySetVar<<TargetCurve as PairingEngine>::Fr, <BaseCurve as PairingEngine>::Fr>, 
    evaluations: &EvaluationsVar<<TargetCurve as PairingEngine>::Fr, <BaseCurve as PairingEngine>::Fr>, 
    proof: &<MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> as PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr>>::BatchLCProofVar, 
    rand_data: &PCCheckRandomDataVar<<TargetCurve as PairingEngine>::Fr, <BaseCurve as PairingEngine>::Fr>
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<<BaseCurve as PairingEngine>::Fr>,

Add to ConstraintSystem<ConstraintF> new constraints that conditionally check that proof is a valid evaluation proof at the points in query_set for the combinations linear_combinations. Read more

pub fn create_labeled_commitment(
    label: String, 
    commitment: <MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> as PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr>>::CommitmentVar, 
    degree_bound: Option<FpGadget<<BaseCurve as PairingEngine>::Fr>>
) -> <MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> as PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr>>::LabeledCommitmentVar

Create the labeled commitment gadget from the commitment gadget

pub fn create_prepared_labeled_commitment(
    label: String, 
    prepared_commitment: <MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> as PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr>>::PreparedCommitmentVar, 
    degree_bound: Option<FpGadget<<BaseCurve as PairingEngine>::Fr>>
) -> <MarlinKZG10Gadget<TargetCurve, BaseCurve, PG> as PCCheckVar<<TargetCurve as PairingEngine>::Fr, MarlinKZG10<TargetCurve>, <BaseCurve as PairingEngine>::Fr>>::PreparedLabeledCommitmentVar

Create the prepared labeled commitment gadget from the commitment gadget

impl<E> PolynomialCommitment<<E as PairingEngine>::Fr> for MarlinKZG10<E> where
    E: PairingEngine,

pub fn setup<R>(
    max_degree: usize, 
    rng: &mut R
) -> Result<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::UniversalParams, <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Error> where
    R: RngCore,

Constructs public parameters when given as input the maximum degree max_degree for the polynomial commitment scheme.

pub fn trim(
    parameters: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::UniversalParams, 
    supported_degree: usize, 
    supported_hiding_bound: usize, 
    enforced_degree_bounds: Option<&[usize]>
) -> Result<(<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::CommitterKey, <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::VerifierKey), <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Error>

Specializes the public parameters for polynomials up to the given supported_degree and for enforcing degree bounds in the range 1..=supported_degree.

pub fn commit<'a>(
    ck: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::CommitterKey, 
    polynomials: impl IntoIterator<Item = &'a LabeledPolynomial<<E as PairingEngine>::Fr>>, 
    rng: Option<&mut dyn RngCore>
) -> Result<(Vec<LabeledCommitment<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment>, Global>, Vec<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Randomness, Global>), <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Error>

Outputs a commitment to polynomial.

pub fn open<'a>(
    ck: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::CommitterKey, 
    labeled_polynomials: impl IntoIterator<Item = &'a LabeledPolynomial<<E as PairingEngine>::Fr>>, 
    _commitments: impl IntoIterator<Item = &'a LabeledCommitment<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment>>, 
    point: <E as PairingEngine>::Fr, 
    opening_challenge: <E as PairingEngine>::Fr, 
    rands: impl IntoIterator<Item = &'a <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Randomness>, 
    _rng: Option<&mut dyn RngCore>
) -> Result<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Proof, <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Error> where
    <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Randomness: 'a,
    <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment: 'a,

On input a polynomial p and a point point, outputs a proof for the same.

pub fn check<'a, R>(
    vk: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::VerifierKey, 
    commitments: impl IntoIterator<Item = &'a LabeledCommitment<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment>>, 
    point: <E as PairingEngine>::Fr, 
    values: impl IntoIterator<Item = <E as PairingEngine>::Fr>, 
    proof: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Proof, 
    opening_challenge: <E as PairingEngine>::Fr, 
    _rng: &mut R
) -> Result<bool, <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Error> where
    R: RngCore,
    <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment: 'a,

Verifies that value is the evaluation at x of the polynomial committed inside comm.

pub fn check_combinations<'a, R>(
    vk: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::VerifierKey, 
    lc_s: impl IntoIterator<Item = &'a LinearCombination<<E as PairingEngine>::Fr>>, 
    commitments: impl IntoIterator<Item = &'a LabeledCommitment<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment>>, 
    query_set: &BTreeSet<(String, (String, <E as PairingEngine>::Fr))>, 
    evaluations: &BTreeMap<(String, <E as PairingEngine>::Fr), <E as PairingEngine>::Fr>, 
    proof: &BatchLCProof<<E as PairingEngine>::Fr, MarlinKZG10<E>>, 
    opening_challenge: <E as PairingEngine>::Fr, 
    rng: &mut R
) -> Result<bool, <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Error> where
    R: RngCore,
    <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment: 'a,

Checks that values are the true evaluations at query_set of the polynomials committed in labeled_commitments.

pub fn open_combinations_individual_opening_challenges<'a>(
    ck: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::CommitterKey, 
    linear_combinations: impl IntoIterator<Item = &'a LinearCombination<<E as PairingEngine>::Fr>>, 
    polynomials: impl IntoIterator<Item = &'a LabeledPolynomial<<E as PairingEngine>::Fr>>, 
    commitments: impl IntoIterator<Item = &'a LabeledCommitment<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment>>, 
    query_set: &BTreeSet<(String, (String, <E as PairingEngine>::Fr))>, 
    opening_challenges: &dyn Fn(u64), 
    rands: impl IntoIterator<Item = &'a <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Randomness>
) -> Result<BatchLCProof<<E as PairingEngine>::Fr, MarlinKZG10<E>>, <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Error> where
    <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Randomness: 'a,
    <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment: 'a,

On input a list of polynomials, linear combinations of those polynomials, and a query set, open_combination outputs a proof of evaluation of the combinations at the points in the query set.

pub fn check_combinations_individual_opening_challenges<'a, R>(
    vk: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::VerifierKey, 
    linear_combinations: impl IntoIterator<Item = &'a LinearCombination<<E as PairingEngine>::Fr>>, 
    commitments: impl IntoIterator<Item = &'a LabeledCommitment<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment>>, 
    query_set: &BTreeSet<(String, (String, <E as PairingEngine>::Fr))>, 
    evaluations: &BTreeMap<(String, <E as PairingEngine>::Fr), <E as PairingEngine>::Fr>, 
    proof: &BatchLCProof<<E as PairingEngine>::Fr, MarlinKZG10<E>>, 
    opening_challenges: &dyn Fn(u64), 
    rng: &mut R
) -> Result<bool, <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Error> where
    R: RngCore,
    <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment: 'a,

Check combinations with individual challenges.

type BatchProof = Vec<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Proof, Global>

The evaluation proof for a query set.

type Commitment = Commitment<E>

The commitment to a polynomial.

type CommitterKey = CommitterKey<E>

The committer key for the scheme; used to commit to a polynomial and then open the commitment to produce an evaluation proof. Read more

type Error = Error

The error type for the scheme.

type PreparedCommitment = PreparedCommitment<E>

The prepared commitment to a polynomial.

type PreparedVerifierKey = PreparedVerifierKey<E>

The prepared verifier key for the scheme; used to check an evaluation proof.

type Proof = Proof<E>

The evaluation proof for a single point.

type Randomness = Randomness<E>

The commitment randomness.

type UniversalParams = UniversalParams<E>

The universal parameters for the commitment scheme. These are “trimmed” down to Self::CommitterKey and Self::VerifierKey by Self::trim. Read more

type VerifierKey = VerifierKey<E>

The verifier key for the scheme; used to check an evaluation proof.

pub fn batch_check<'a, R>(
    vk: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::VerifierKey, 
    commitments: impl IntoIterator<Item = &'a LabeledCommitment<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment>>, 
    query_set: &BTreeSet<(String, (String, <E as PairingEngine>::Fr))>, 
    values: &BTreeMap<(String, <E as PairingEngine>::Fr), <E as PairingEngine>::Fr>, 
    proof: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::BatchProof, 
    opening_challenge: <E as PairingEngine>::Fr, 
    rng: &mut R
) -> Result<bool, <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Error> where
    R: RngCore,
    <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment: 'a,

Checks that values are the true evaluations at query_set of the polynomials committed in labeled_commitments. Read more

pub fn open_combinations<'a>(
    ck: &<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::CommitterKey, 
    lc_s: impl IntoIterator<Item = &'a LinearCombination<<E as PairingEngine>::Fr>>, 
    polynomials: impl IntoIterator<Item = &'a LabeledPolynomial<<E as PairingEngine>::Fr>>, 
    commitments: impl IntoIterator<Item = &'a LabeledCommitment<<MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment>>, 
    query_set: &BTreeSet<(String, (String, <E as PairingEngine>::Fr))>, 
    opening_challenge: <E as PairingEngine>::Fr, 
    rands: impl IntoIterator<Item = &'a <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Randomness>, 
    rng: Option<&mut dyn RngCore>
) -> Result<BatchLCProof<<E as PairingEngine>::Fr, MarlinKZG10<E>>, <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Error> where
    <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Randomness: 'a,
    <MarlinKZG10<E> as PolynomialCommitment<<E as PairingEngine>::Fr>>::Commitment: 'a,

On input a list of polynomials, linear combinations of those polynomials, and a query set, open_combination outputs a proof of evaluation of the combinations at the points in the query set. Read more

fn batch_open<'a>(
    ck: &Self::CommitterKey, 
    labeled_polynomials: impl IntoIterator<Item = &'a LabeledPolynomial<F>>, 
    commitments: impl IntoIterator<Item = &'a LabeledCommitment<Self::Commitment>>, 
    query_set: &BTreeSet<(String, (String, F))>, 
    opening_challenge: F, 
    rands: impl IntoIterator<Item = &'a Self::Randomness>, 
    rng: Option<&mut dyn RngCore>
) -> Result<Self::BatchProof, Self::Error> where
    Self::Randomness: 'a,
    Self::Commitment: 'a,

On input a list of labeled polynomials and a query set, open outputs a proof of evaluation of the polynomials at the points in the query set. Read more

Auto Trait Implementations

impl<E> RefUnwindSafe for MarlinKZG10<E> where
    E: RefUnwindSafe,

impl<E> Send for MarlinKZG10<E>

impl<E> Sync for MarlinKZG10<E>

impl<E> Unpin for MarlinKZG10<E> where
    E: Unpin,

impl<E> UnwindSafe for MarlinKZG10<E> where
    E: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. 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> 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. Read more

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,

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

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. Read more

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,

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

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

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

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

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>,
    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,

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,

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. Read more

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

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

impl<T> Same<T> for T

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. Read more

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,

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,

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,

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

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. Read more

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. Read more

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

pub fn vzip(self) -> V