Struct thfmr_util::graphql::Cursor[][src]

pub struct Cursor<T: FromStr + ToString> { /* fields omitted */ }
Expand description

A cursor implementation for use with GraphQL, implements async_graphql::connection::CursorType.

The Cursor consists of a prefix and a ID part. The prefix specifies what kind of object it refers to and the ID specifies which specific object it refers to.

let cursor = Cursor::new("Album", 1);

assert_eq!(cursor.encode_cursor(), "QWxidW06MQ=="); // Album:1


impl<T> Cursor<T> where
    T: FromStr + ToString + Clone

pub fn new(prefix: &str, value: T) -> Cursor<T>[src]

Create a new Cursor with the given prefix and value.

This can be used by server implementations to create the appropriate cursor.

pub fn into_prefix(self, prefix: &str) -> Result<T, CursorError>[src]

Deconstruct this cursor into the appropriate ID when its prefix matches.

This function can be used by the server to extract the contained ID. It returns Error when the cursor does not have the specified prefix.

let cursor = Cursor::new("MyPrefix", 10);

assert_eq!(cursor.into_prefix("MyPrefix"), Ok(10));
assert_eq!(cursor.into_prefix("OtherPrefix"), Err(CursorError::InvalidIdentifier));

Trait Implementations

impl<T: Clone + FromStr + ToString> Clone for Cursor<T>[src]

fn clone(&self) -> Cursor<T>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<T: FromStr + ToString> CursorType for Cursor<T>[src]

Implementation for async_graphql cursors

fn decode_cursor(s: &str) -> Result<Self, Self::Error>[src]

Decode the GraphQL input string into a Cursor

fn encode_cursor(&self) -> String[src]

Encode the Cursor to a string for use in the GraphQL answer

type Error = CursorError

Error type for decode_cursor.

Auto Trait Implementations

impl<T> RefUnwindSafe for Cursor<T> where
    T: RefUnwindSafe

impl<T> Send for Cursor<T> where
    T: Send

impl<T> Sync for Cursor<T> where
    T: Sync

impl<T> Unpin for Cursor<T> where
    T: Unpin

impl<T> UnwindSafe for Cursor<T> where
    T: UnwindSafe

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

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[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

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

🔬 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, 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>[src]

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>[src]

Performs the conversion.

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

pub fn vzip(self) -> V