Enum toql_core::join::Join

source · [−]

pub enum Join<E: Keyed> {
    Entity(Box<E>),
    Key(E::Key),
}

Expand description

The Join struct that hold either an entity or its key.

Variants

`Entity(Box<E>)`

Full entity is held. The entity is wrapped inside a Box. That does allow circular dependencies, in theory. In practice the compiler goes wild :(

`Key(E::Key)`

The entities key

Implementations

source

impl<T> Join<T> where
T: Keyed,

source

pub fn with_entity(entity: T) -> Self

Constructs join for entity

source

pub fn with_key(key: impl Into<<T as Keyed>::Key>) -> Self

Constructs join for key

source

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

Returns entity or None, if key is held.

source

pub fn entity_mut(&mut self) -> Option<&mut T>

Returns mutable entity or None, if key is held.

source

pub fn entity_or_err<E>(&self, err: E) -> Result<&T, E>

Returns entity or error E, if key is held.

source

pub fn entity_mut_or_err<E>(&mut self, err: E) -> Result<&mut T, E>

Returns mut entity or error E, if key is held.

source

pub fn key(&self) -> <T as Keyed>::Key where
<T as Keyed>::Key: Clone,

Returns a key. If entity is held, key is taken from that entity

source

pub fn into_entity(self) -> Result<T, ToqlError>

Unwraps join into its entity. Can fail

Trait Implementations

source

impl<E> Clone for Join<E> where
E: Clone + Keyed,
<E as Keyed>::Key: Clone,

source

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<E: Debug + Keyed> Debug for Join<E> where
E::Key: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<E> Default for Join<E> where
E: Default + Keyed,

source

fn default() -> Self

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

source

impl<T, R, E> FromRow<R, E> for Join<T> where
T: Keyed + FromRow<R, E>,
E: From<ToqlError>,

source

fn forward<'a, I>(iter: &mut I) -> Result<usize, E> where
I: Iterator<Item = &'a Select>,
Self: Sized,

Returns the number of selects This is needed to advance the iterator and the row index. The Deserializer needs this information to skip left joins that have fields selected but are null. Those left joins cause select information in the select stream that must be skipped. Read more

source

fn from_row<'a, I>(
 row: &R,
 i: &mut usize,
 iter: &mut I
) -> Result<Option<Self>, E> where
 I: Iterator<Item = &'a Select> + Clone,
 Self: Sized,

Read row values into struct, starting from index. Advances iter and index Returns None for value unselected values or joined entities that have null keys. Return Error, if value is selected, but cannot be converted. Read more

source

impl<T> KeyFields for Join<T> where
T: KeyFields + Keyed,
<T as Keyed>::Key: KeyFields,

type Entity = <T as KeyFields>::Entity

source

fn fields() -> Vec<String>

Return primary key fields for a given entity.

source

fn params(&self) -> Vec<SqlArg>

Return key values as params. Useful to loop across a composite key.

source

impl<T> Keyed for Join<T> where
T: Keyed,
T::Key: Clone,

type Key = <T as Keyed>::Key

Type of key.

source

fn key(&self) -> T::Key

Return value of the key for a given entity.

source

impl<T> Keyed for &Join<T> where
T: Keyed,
T::Key: Clone,

type Key = <T as Keyed>::Key

Type of key.

source

fn key(&self) -> T::Key

Return value of the key for a given entity.

source

impl<T> KeyedMut for Join<T> where
T: KeyedMut,
T::Key: Clone,

source

fn set_key(&mut self, key: T::Key)

Set the key of the implementing struct.

source

impl<E: PartialEq + Keyed> PartialEq<Join<E>> for Join<E> where
E::Key: PartialEq,

source

fn eq(&self, other: &Join<E>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &Join<E>) -> bool

This method tests for !=.

source

impl<T> TreeIdentity for Join<T> where
 T: Keyed,
 <T as Keyed>::Key: Clone,
 T: TreeIdentity,
 <T as Keyed>::Key: TryFrom<Vec<SqlArg>, Error = ToqlError>,

source

fn auto_id<'a, I>(descendents: I) -> Result<bool, ToqlError> where
I: Iterator<Item = FieldPath<'a>>,

Returns true, if struct located at descendents has database generated keys.

source

fn set_id<'a, 'b, I>(
 &mut self,
 descendents: I,
 action: &'b IdentityAction
) -> Result<(), ToqlError> where
 I: Iterator<Item = FieldPath<'a>> + Clone,

Set or refresh keys of structs located at descendents.

source

impl<T, R, E> TreeIndex<R, E> for Join<T> where
T: Keyed + TreeIndex<R, E>,
E: From<ToqlError>,

source

fn index<'a, I>(
 descendents: I,
 rows: &[R],
 row_offset: usize,
 index: &mut HashMap<u64, Vec<usize>>
) -> Result<(), E> where
 I: Iterator<Item = FieldPath<'a>> + Clone,

source

impl<T> TreeInsert for Join<T> where
T: Keyed + TreeInsert + Mapped,
<T as Keyed>::Key: Key + Clone,

source

fn columns<'a, I>(descendents: I) -> Result<SqlExpr, ToqlError> where
I: Iterator<Item = FieldPath<'a>>,

Return columns of struct located at descendents.

source

fn values<'a, 'b, I, J>(
 &self,
 descendents: I,
 roles: &HashSet<String>,
 should_insert: &mut J,
 values: &mut SqlExpr
) -> Result<(), ToqlError> where
 I: Iterator<Item = FieldPath<'a>> + Clone,
 J: Iterator<Item = &'b bool>,

Return values of structs located at descendents. The should_insert argument allows the method to only insert a part of the collection. This is needed to deal with newly added merges. Read more

source

impl<T, R, E> TreeMerge<R, E> for Join<T> where
T: Keyed + TreeMerge<R, E>,
E: From<ToqlError>,

source

fn merge<'a, I>(
 &mut self,
 descendents: I,
 field: &str,
 rows: &[R],
 row_offset: usize,
 index: &HashMap<u64, Vec<usize>>,
 selection_stream: &SelectStream
) -> Result<(), E> where
 I: Iterator<Item = FieldPath<'a>> + Clone,

source

impl<T> TreePredicate for Join<T> where
 T: Keyed,
 <T as Keyed>::Key: Clone,
 T: TreePredicate,

source

fn columns<'a, I>(descendents: I) -> Result<Vec<String>, ToqlError> where
I: Iterator<Item = FieldPath<'a>>,

Return the key column names

source

fn args<'a, I>(
 &self,
 descendents: I,
 args: &mut Vec<SqlArg>
) -> Result<(), ToqlError> where
 I: Iterator<Item = FieldPath<'a>> + Clone,

Return the key column values

source

impl<T> TreeUpdate for Join<T> where
T: Keyed + TreeUpdate + Mapped,
<T as Keyed>::Key: Key + Clone,

source

fn update<'a, I>(
 &self,
 descendents: I,
 fields: &HashSet<String>,
 roles: &HashSet<String>,
 exprs: &mut Vec<SqlExpr>
) -> Result<(), ToqlError> where
 I: Iterator<Item = FieldPath<'a>> + Clone,

source

impl<E: Eq + Keyed> Eq for Join<E> where
E::Key: Eq,

source

impl<E: Keyed> StructuralEq for Join<E>

source

impl<E: Keyed> StructuralPartialEq for Join<E>

Auto Trait Implementations

impl<E> RefUnwindSafe for Join<E> where
E: RefUnwindSafe,
<E as Keyed>::Key: RefUnwindSafe,

impl<E> Send for Join<E> where
E: Send,
<E as Keyed>::Key: Send,

impl<E> Sync for Join<E> where
E: Sync,
<E as Keyed>::Key: Sync,

impl<E> Unpin for Join<E> where
<E as Keyed>::Key: Unpin,

impl<E> UnwindSafe for Join<E> where
E: UnwindSafe,
<E as Keyed>::Key: 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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,

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)

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::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

Enum toql_core::join::Join

Variants

Entity(Box<E>)

Key(E::Key)

Implementations

impl<T> Join<T> where T: Keyed,

pub fn with_entity(entity: T) -> Self

pub fn with_key(key: impl Into<<T as Keyed>::Key>) -> Self

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

pub fn entity_mut(&mut self) -> Option<&mut T>

pub fn entity_or_err<E>(&self, err: E) -> Result<&T, E>

pub fn entity_mut_or_err<E>(&mut self, err: E) -> Result<&mut T, E>

pub fn key(&self) -> <T as Keyed>::Key where <T as Keyed>::Key: Clone,

pub fn into_entity(self) -> Result<T, ToqlError>

Trait Implementations

impl<E> Clone for Join<E> where E: Clone + Keyed, <E as Keyed>::Key: Clone,

fn clone(&self) -> Self

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

impl<E: Debug + Keyed> Debug for Join<E> where E::Key: Debug,

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

impl<E> Default for Join<E> where E: Default + Keyed,

fn default() -> Self

impl<T, R, E> FromRow<R, E> for Join<T> where T: Keyed + FromRow<R, E>, E: From<ToqlError>,

fn forward<'a, I>(iter: &mut I) -> Result<usize, E> where I: Iterator<Item = &'a Select>, Self: Sized,

fn from_row<'a, I>( row: &R, i: &mut usize, iter: &mut I) -> Result<Option<Self>, E> where I: Iterator<Item = &'a Select> + Clone, Self: Sized,

impl<T> KeyFields for Join<T> where T: KeyFields + Keyed, <T as Keyed>::Key: KeyFields,

type Entity = <T as KeyFields>::Entity

fn fields() -> Vec<String>

fn params(&self) -> Vec<SqlArg>

impl<T> Keyed for Join<T> where T: Keyed, T::Key: Clone,

type Key = <T as Keyed>::Key

fn key(&self) -> T::Key

impl<T> Keyed for &Join<T> where T: Keyed, T::Key: Clone,

type Key = <T as Keyed>::Key

fn key(&self) -> T::Key

impl<T> KeyedMut for Join<T> where T: KeyedMut, T::Key: Clone,

fn set_key(&mut self, key: T::Key)

impl<E: PartialEq + Keyed> PartialEq<Join<E>> for Join<E> where E::Key: PartialEq,

fn eq(&self, other: &Join<E>) -> bool

fn ne(&self, other: &Join<E>) -> bool

impl<T> TreeIdentity for Join<T> where T: Keyed, <T as Keyed>::Key: Clone, T: TreeIdentity, <T as Keyed>::Key: TryFrom<Vec<SqlArg>, Error = ToqlError>,

fn auto_id<'a, I>(descendents: I) -> Result<bool, ToqlError> where I: Iterator<Item = FieldPath<'a>>,

fn set_id<'a, 'b, I>( &mut self, descendents: I, action: &'b IdentityAction) -> Result<(), ToqlError> where I: Iterator<Item = FieldPath<'a>> + Clone,

impl<T, R, E> TreeIndex<R, E> for Join<T> where T: Keyed + TreeIndex<R, E>, E: From<ToqlError>,

fn index<'a, I>( descendents: I, rows: &[R], row_offset: usize, index: &mut HashMap<u64, Vec<usize>>) -> Result<(), E> where I: Iterator<Item = FieldPath<'a>> + Clone,

impl<T> TreeInsert for Join<T> where T: Keyed + TreeInsert + Mapped, <T as Keyed>::Key: Key + Clone,

fn columns<'a, I>(descendents: I) -> Result<SqlExpr, ToqlError> where I: Iterator<Item = FieldPath<'a>>,

fn values<'a, 'b, I, J>( &self, descendents: I, roles: &HashSet<String>, should_insert: &mut J, values: &mut SqlExpr) -> Result<(), ToqlError> where I: Iterator<Item = FieldPath<'a>> + Clone, J: Iterator<Item = &'b bool>,

impl<T, R, E> TreeMerge<R, E> for Join<T> where T: Keyed + TreeMerge<R, E>, E: From<ToqlError>,

fn merge<'a, I>( &mut self, descendents: I, field: &str, rows: &[R], row_offset: usize, index: &HashMap<u64, Vec<usize>>, selection_stream: &SelectStream) -> Result<(), E> where I: Iterator<Item = FieldPath<'a>> + Clone,

impl<T> TreePredicate for Join<T> where T: Keyed, <T as Keyed>::Key: Clone, T: TreePredicate,

fn columns<'a, I>(descendents: I) -> Result<Vec<String>, ToqlError> where I: Iterator<Item = FieldPath<'a>>,

fn args<'a, I>( &self, descendents: I, args: &mut Vec<SqlArg>) -> Result<(), ToqlError> where I: Iterator<Item = FieldPath<'a>> + Clone,

impl<T> TreeUpdate for Join<T> where T: Keyed + TreeUpdate + Mapped, <T as Keyed>::Key: Key + Clone,

fn update<'a, I>( &self, descendents: I, fields: &HashSet<String>, roles: &HashSet<String>, exprs: &mut Vec<SqlExpr>) -> Result<(), ToqlError> where I: Iterator<Item = FieldPath<'a>> + Clone,

impl<E: Eq + Keyed> Eq for Join<E> where E::Key: Eq,

impl<E: Keyed> StructuralEq for Join<E>

impl<E: Keyed> StructuralPartialEq for Join<E>

Auto Trait Implementations

impl<E> RefUnwindSafe for Join<E> where E: RefUnwindSafe, <E as Keyed>::Key: RefUnwindSafe,

impl<E> Send for Join<E> where E: Send, <E as Keyed>::Key: Send,

impl<E> Sync for Join<E> where E: Sync, <E as Keyed>::Key: Sync,

impl<E> Unpin for Join<E> where <E as Keyed>::Key: Unpin,

impl<E> UnwindSafe for Join<E> where E: UnwindSafe, <E as Keyed>::Key: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Owned = T

`Entity(Box<E>)`

`Key(E::Key)`

impl<T> Join<T> where
T: Keyed,

pub fn key(&self) -> <T as Keyed>::Key where
<T as Keyed>::Key: Clone,

impl<E> Clone for Join<E> where
E: Clone + Keyed,
<E as Keyed>::Key: Clone,

impl<E: Debug + Keyed> Debug for Join<E> where
E::Key: Debug,

impl<E> Default for Join<E> where
E: Default + Keyed,

impl<T, R, E> FromRow<R, E> for Join<T> where
T: Keyed + FromRow<R, E>,
E: From<ToqlError>,

fn forward<'a, I>(iter: &mut I) -> Result<usize, E> where
I: Iterator<Item = &'a Select>,
Self: Sized,

fn from_row<'a, I>(
row: &R,
i: &mut usize,
iter: &mut I
) -> Result<Option<Self>, E> where
I: Iterator<Item = &'a Select> + Clone,
Self: Sized,

impl<T> KeyFields for Join<T> where
T: KeyFields + Keyed,
<T as Keyed>::Key: KeyFields,

impl<T> Keyed for Join<T> where
T: Keyed,
T::Key: Clone,

impl<T> Keyed for &Join<T> where
T: Keyed,
T::Key: Clone,

impl<T> KeyedMut for Join<T> where
T: KeyedMut,
T::Key: Clone,

impl<E: PartialEq + Keyed> PartialEq<Join<E>> for Join<E> where
E::Key: PartialEq,

impl<T> TreeIdentity for Join<T> where
T: Keyed,
<T as Keyed>::Key: Clone,
T: TreeIdentity,
<T as Keyed>::Key: TryFrom<Vec<SqlArg>, Error = ToqlError>,

fn auto_id<'a, I>(descendents: I) -> Result<bool, ToqlError> where
I: Iterator<Item = FieldPath<'a>>,

fn set_id<'a, 'b, I>(
&mut self,
descendents: I,
action: &'b IdentityAction
) -> Result<(), ToqlError> where
I: Iterator<Item = FieldPath<'a>> + Clone,

impl<T, R, E> TreeIndex<R, E> for Join<T> where
T: Keyed + TreeIndex<R, E>,
E: From<ToqlError>,

fn index<'a, I>(
descendents: I,
rows: &[R],
row_offset: usize,
index: &mut HashMap<u64, Vec<usize>>
) -> Result<(), E> where
I: Iterator<Item = FieldPath<'a>> + Clone,

impl<T> TreeInsert for Join<T> where
T: Keyed + TreeInsert + Mapped,
<T as Keyed>::Key: Key + Clone,

fn columns<'a, I>(descendents: I) -> Result<SqlExpr, ToqlError> where
I: Iterator<Item = FieldPath<'a>>,

fn values<'a, 'b, I, J>(
&self,
descendents: I,
roles: &HashSet<String>,
should_insert: &mut J,
values: &mut SqlExpr
) -> Result<(), ToqlError> where
I: Iterator<Item = FieldPath<'a>> + Clone,
J: Iterator<Item = &'b bool>,

impl<T, R, E> TreeMerge<R, E> for Join<T> where
T: Keyed + TreeMerge<R, E>,
E: From<ToqlError>,

fn merge<'a, I>(
&mut self,
descendents: I,
field: &str,
rows: &[R],
row_offset: usize,
index: &HashMap<u64, Vec<usize>>,
selection_stream: &SelectStream
) -> Result<(), E> where
I: Iterator<Item = FieldPath<'a>> + Clone,

impl<T> TreePredicate for Join<T> where
T: Keyed,
<T as Keyed>::Key: Clone,
T: TreePredicate,

fn columns<'a, I>(descendents: I) -> Result<Vec<String>, ToqlError> where
I: Iterator<Item = FieldPath<'a>>,

fn args<'a, I>(
&self,
descendents: I,
args: &mut Vec<SqlArg>
) -> Result<(), ToqlError> where
I: Iterator<Item = FieldPath<'a>> + Clone,

impl<T> TreeUpdate for Join<T> where
T: Keyed + TreeUpdate + Mapped,
<T as Keyed>::Key: Key + Clone,

fn update<'a, I>(
&self,
descendents: I,
fields: &HashSet<String>,
roles: &HashSet<String>,
exprs: &mut Vec<SqlExpr>
) -> Result<(), ToqlError> where
I: Iterator<Item = FieldPath<'a>> + Clone,

impl<E: Eq + Keyed> Eq for Join<E> where
E::Key: Eq,

impl<E> RefUnwindSafe for Join<E> where
E: RefUnwindSafe,
<E as Keyed>::Key: RefUnwindSafe,

impl<E> Send for Join<E> where
E: Send,
<E as Keyed>::Key: Send,

impl<E> Sync for Join<E> where
E: Sync,
<E as Keyed>::Key: Sync,

impl<E> Unpin for Join<E> where
<E as Keyed>::Key: Unpin,

impl<E> UnwindSafe for Join<E> where
E: UnwindSafe,
<E as Keyed>::Key: UnwindSafe,

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

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

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

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

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

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

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

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