Skip to main content

Attribute

Struct Attribute 

Source
pub struct Attribute<S: InlineEncoding> { /* private fields */ }
Expand description

A typed reference to an attribute: a rooted Fragment carrying the identity-determining facts, tagged with a phantom value-schema marker.

The root id is cached alongside the fragment so .id() is a field read — entity!{} codegen calls it once per attribute per fact, and walking the fragment’s exports PATCH each time dominated the pre-0.40 entities/union benches.

Implementations§

Source§

impl<S: InlineEncoding> Attribute<S>

Source

pub fn id(&self) -> Id

The attribute’s id, equal to the wrapped fragment’s root.

Source

pub fn raw(&self) -> RawId

Return the underlying raw id bytes.

Source

pub fn fragment(&self) -> &Fragment

The identity-determining fragment.

Source

pub fn inline_from<T: IntoInline<S>>(&self, v: T) -> Inline<S>

Convert a host value into a typed Inline<S> using the Field’s schema. This is a small convenience wrapper around the IntoInline trait and simplifies macro expansion: af.inline_from(expr) preserves the schema S for type inference.

Source

pub fn encoded_from<V>(&self, v: V) -> Encoded<S>

Macro-side entry point: produce the Encoded<S> the entity!{} codegen folds into a Fragment.

Dispatches via IntoEncoded, parameterised by the schema’s EncodingS itself for inline schemas, the inner BlobEncoding for Handle<T>. The resulting Output is lifted into a Encoded via ToEncoded.

Source

pub fn as_variable(&self, v: Variable<S>) -> Variable<S>

Coerce an existing variable of any schema into a variable typed with this field’s schema. This is a convenience for macros: they can allocate an untyped/UnknownInline variable and then annotate it with the field’s schema using af.as_variable(raw_var).

The operation is a zero-cost conversion as variables are simply small integer indexes; the implementation uses an unsafe transmute to change the type parameter without moving the underlying data.

Trait Implementations§

Source§

impl<S: InlineEncoding> Clone for Attribute<S>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S: Debug + InlineEncoding> Debug for Attribute<S>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S> Describe for Attribute<S>
where S: InlineEncoding,

Source§

fn describe(&self) -> Fragment

Produces a Fragment describing this instance, with any long-form bytes embedded in its local blob store.
Source§

fn id(&self) -> Id

Returns the id of this instance. Default: derive from self.describe().root(). Override when the id is cheaper to compute directly (e.g. Attribute<S> reads it from its stored fragment).
Source§

impl<S: Eq + InlineEncoding> Eq for Attribute<S>

Source§

impl<S: InlineEncoding> From<Fragment> for Attribute<S>

Wrap a rooted fragment as a typed attribute.

The fragment’s root() is the attribute id; its facts (typically metadata::iri | metadata::name together with metadata::value_encoding) are carried through to [Describe] so the attribute remains queryable in the metadata registry by its originating identity attribute.

Pinning a schema’s attribute ids (so local renames don’t churn the schema) is what the [attributes!] macro is for — declare them with explicit hex literals there.

Source§

fn from(fragment: Fragment) -> Self

Converts to this type from the input type.
Source§

impl<S: PartialEq + InlineEncoding> PartialEq for Attribute<S>

Source§

fn eq(&self, other: &Attribute<S>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<S: InlineEncoding> StructuralPartialEq for Attribute<S>

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for Attribute<S>

§

impl<S> !UnwindSafe for Attribute<S>

§

impl<S> Freeze for Attribute<S>

§

impl<S> Send for Attribute<S>
where S: Send,

§

impl<S> Sync for Attribute<S>
where S: Sync,

§

impl<S> Unpin for Attribute<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for Attribute<S>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchiveOwner for T
where T: Send + Sync + 'static + ?Sized,

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<S, T> IntoBlob<S> for T
where S: BlobEncoding, T: IntoEncoded<S, Output = Blob<S>>,

Source§

fn to_blob(self) -> Blob<S>
where Self: Sized,

Convert directly to Blob<S>.
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<S, T> IntoEncoded<S> for T
where S: Encodes<T>,

Source§

type Output = <S as Encodes<T>>::Output

The concrete form this source produces.
Source§

fn into_encoded(self) -> <T as IntoEncoded<S>>::Output

Run the conversion.
Source§

impl<S, T> IntoInline<S> for T
where S: InlineEncoding, T: IntoEncoded<S, Output = Inline<S>>,

Source§

fn to_inline(self) -> Inline<S>
where Self: Sized,

Convert directly to Inline<S>.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V