Skip to main content

Navigation

Struct Navigation 

Source
pub struct Navigation<T> { /* private fields */ }
Expand description

Marker value for a single related entity navigation.

Navigation fields are not persisted as columns. They exist so #[derive(Entity)] can attach navigation metadata to the entity while future loading APIs decide explicitly when related rows are fetched.

Implementations§

Source§

impl<T> Navigation<T>

Source

pub const fn empty() -> Self

Creates an empty navigation value.

Source

pub fn loaded(value: T) -> Self

Creates a navigation value containing a loaded related entity.

Source

pub fn from_option(value: Option<T>) -> Self

Creates a navigation value from an optional related entity.

Source

pub fn as_ref(&self) -> Option<&T>

Returns the loaded related entity when one has been attached.

Source

pub fn set(&mut self, value: Option<T>)

Replaces the loaded related entity.

Trait Implementations§

Source§

impl<T: Clone> Clone for Navigation<T>

Source§

fn clone(&self) -> Navigation<T>

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<T: Debug> Debug for Navigation<T>

Source§

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

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

impl<T> Default for Navigation<T>

Source§

fn default() -> Self

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

impl<T: PartialEq> PartialEq for Navigation<T>

Source§

fn eq(&self, other: &Navigation<T>) -> 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<T: Eq> Eq for Navigation<T>

Source§

impl<T> StructuralPartialEq for Navigation<T>

Auto Trait Implementations§

§

impl<T> Freeze for Navigation<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Navigation<T>
where T: RefUnwindSafe,

§

impl<T> Send for Navigation<T>
where T: Send,

§

impl<T> Sync for Navigation<T>
where T: Sync,

§

impl<T> Unpin for Navigation<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Navigation<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Navigation<T>
where T: UnwindSafe,

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> 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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more