Skip to main content

ResumeToken

Struct ResumeToken 

pub struct ResumeToken(/* private fields */);
Expand description

Where the far side should resume a pull from, as the far side minted it.

Opaque: the caller stores it and hands it back, and never reads it (SY-15). Text rather than bytes, because a token is what an HTTP peer puts in a query string or a Durable Object in a cursor column, and because bytes would render in JSON as an array of integers that no operator can read. It is the wire form of a peer’s SyncPeer::Resume; turning one into the other is the peer adapter’s, and nothing here assumes how.

§Examples

use happenstance_sync::wire::ResumeToken;

let token = ResumeToken::new("group:42");
assert_eq!(token.as_str(), "group:42");
assert_eq!(serde_json::to_string(&token)?, r#""group:42""#);

Implementations§

§

impl ResumeToken

pub fn new(token: impl Into<Box<str>>) -> Self

Wraps the text a peer minted.

pub fn as_str(&self) -> &str

The text, to hand back to the peer that minted it.

Trait Implementations§

§

impl Clone for ResumeToken

§

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
§

impl Debug for ResumeToken

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for ResumeToken

§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl Eq for ResumeToken

§

impl From<StoreResume> for ResumeToken

§

fn from(resume: StoreResume) -> Self

Converts to this type from the input type.
§

impl Hash for ResumeToken

§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl PartialEq for ResumeToken

§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
§

impl Serialize for ResumeToken

§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl StructuralPartialEq for ResumeToken

§

impl TryFrom<&ResumeToken> for StoreResume

Reads back the text From<StoreResume> wrote, and nothing else.

Strict, so the text form is one-to-one: digits only, no sign, no leading zero but the start’s "0", and within u64.

§

type Error = ForeignToken

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

fn try_from(token: &ResumeToken) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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<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 = !

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

fn try_from(value: U) -> Result<T, !>

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.