Skip to main content

Meta

haloumi_ir::meta

Struct Meta

pub struct Meta(/* private fields */);

Expand description

Metadata associated with an IR object.

Implementations§

impl Meta

pub fn at_gate( &mut self, name: impl ToString, region_name: impl ToString, region: Option<RegionIndex>, row: Option<usize>, )

Sets the location at a PLONK gate.

pub fn at_copy_constraint(&mut self, constraint: CopyConstraint)

Sets the location at a copy constraint.

pub fn at_lookup(&mut self, name: impl ToString, idx: usize, row: Option<usize>)

Sets the location at a lookup.

pub fn at_inject(&mut self, region: RegionIndex, index: Option<usize>)

Sets the location at an injection index.

pub fn at_group(&mut self, name: impl ToString, key: Option<GroupKey>)

Sets the group information.

pub fn at_row(&mut self, row: usize)

Sets the row.

pub fn complete_with(&mut self, other: Self)

Completes the metadata with information from the given instance.

Does not overwrite anything that has already been written.

Trait Implementations§

impl Clone for Meta

fn clone(&self) -> Meta

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 Debug for Meta

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

Formats the value using the given formatter. Read more

impl Default for Meta

fn default() -> Meta

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

impl Display for Meta

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

Formats the value using the given formatter. Read more

impl Copy for Meta

Auto Trait Implementations§

impl Freeze for Meta

impl RefUnwindSafe for Meta

impl Send for Meta

impl Sync for Meta

impl Unpin for Meta

impl UnwindSafe for Meta

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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, O> EquivalentTo<O> for T

fn is_equiv<E>(&self, other: &O) -> bool
where E: EqvRelation<T, O>,

Returns true if self is equivalent to other.

impl<L, R, E> EqvRelation<&[L], &[R]> for E
where E: EqvRelation<L, R>,

fn equivalent(lhs: &&[L], rhs: &&[R]) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.

impl<L, R, E> EqvRelation<&L, &R> for E
where E: EqvRelation<L, R>,

fn equivalent(lhs: &&L, rhs: &&R) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.

impl<L, R, E> EqvRelation<&mut L, &mut R> for E
where E: EqvRelation<L, R>,

fn equivalent(lhs: &&mut L, rhs: &&mut R) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.

impl<L, R, E, const N: usize> EqvRelation<[L; N], [R; N]> for E
where E: EqvRelation<L, R>,

fn equivalent(lhs: &[L; N], rhs: &[R; N]) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.

impl<L, R, E> EqvRelation<Box<L>, Box<R>> for E
where E: EqvRelation<L, R>,

fn equivalent(lhs: &Box<L>, rhs: &Box<R>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.

impl<'l, 'r, L, R, E> EqvRelation<Cow<'l, L>, Cow<'r, R>> for E
where L: ToOwned, R: ToOwned, E: EqvRelation<L, R>,

fn equivalent(lhs: &Cow<'l, L>, rhs: &Cow<'r, R>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.

impl<L, R, E> EqvRelation<Option<L>, Option<R>> for E
where E: EqvRelation<L, R>,

fn equivalent(lhs: &Option<L>, rhs: &Option<R>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.

impl<L, R, E> EqvRelation<Rc<L>, Rc<R>> for E
where E: EqvRelation<L, R>,

fn equivalent(lhs: &Rc<L>, rhs: &Rc<R>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.

impl<L, LErr, R, RErr, E> EqvRelation<Result<L, LErr>, Result<R, RErr>> for E
where E: EqvRelation<L, R>,

fn equivalent(lhs: &Result<L, LErr>, rhs: &Result<R, RErr>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.

impl<L, R, E> EqvRelation<Vec<L>, Vec<R>> for E
where E: EqvRelation<L, R>,

fn equivalent(lhs: &Vec<L>, rhs: &Vec<R>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. 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.

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.

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

Performs the conversion.