Struct sync_guid::Guid

pub struct Guid(Repr);

This is a type intended to be used to represent the guids used by sync. It has several benefits over using a String:

1. It's more explicit about what is being stored, and could prevent bugs where a Guid is passed to a function expecting text.

2. Guids are guaranteed to be immutable.

3. It's optimized for the guids commonly used by sync. In particular, short guids (including the guids which would meet PlacesUtils.isValidGuid) do not incur any heap allocation, and are stored inline.

Implementations

impl Guid

pub fn new(s: &str) -> Self

Create a guid from a str.

pub const fn empty() -> Self

Create an empty guid. Usable as a constant.

pub fn random() -> Self

Create a random guid (of 12 base64url characters). Requires the random feature.

pub fn from_string(s: String) -> Self

Convert b into a Guid.

pub fn from_slice(b: &[u8]) -> Self

Convert b into a Guid.

pub fn from_vec(v: Vec<u8>) -> Self

Convert v to a Guid, consuming it.

pub fn as_bytes(&self) -> &[u8]

Get the data backing this Guid as a &[u8].

pub fn as_str(&self) -> &str

Get the data backing this Guid as a &str.

pub fn into_string(self) -> String

Convert this Guid into a String, consuming it in the process.

pub fn is_valid_for_sync_server(&self) -> bool

Returns true for Guids that are deemed valid by the sync server. See https://github.com/mozilla-services/server-syncstorage/blob/d92ef07877aebd05b92f87f6ade341d6a55bffc8/syncstorage/bso.py#L24

pub fn is_valid_for_places(&self) -> bool

Returns true for Guids that are valid places guids, and false for all others.

pub fn is_valid_places_byte(b: u8) -> bool

Returns true if the byte b is a valid base64url byte.

fn new_slow(v: Vec<u8>) -> Self

Trait Implementations

impl AsRef<[u8]> for Guid

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<str> for Guid

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Guid

fn clone(&self) -> Guid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Guid

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

Formats the value using the given formatter.

impl Default for Guid

fn default() -> Self

Create a default guid by calling Guid::empty()

impl Deref for Guid

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl<'de> Deserialize<'de> for Guid

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

Deserialize this value from the given Serde deserializer.

impl Display for Guid

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

Formats the value using the given formatter.

impl Eq for Guid

impl<'a, '_> From<&'a &'_ str> for Guid

fn from(s: &'a &str) -> Guid

Performs the conversion.

impl<'a> From<&'a [u8]> for Guid

fn from(s: &'a [u8]) -> Guid

Performs the conversion.

impl<'a> From<&'a str> for Guid

fn from(s: &'a str) -> Guid

Performs the conversion.

impl From<Guid> for String

fn from(guid: Guid) -> String

Performs the conversion.

impl From<Guid> for Vec<u8>

fn from(guid: Guid) -> Vec<u8>

Performs the conversion.

impl From<String> for Guid

fn from(s: String) -> Guid

Performs the conversion.

impl From<Vec<u8>> for Guid

fn from(v: Vec<u8>) -> Guid

Performs the conversion.

impl FromSql for Guid

fn column_result(value: ValueRef<'_>) -> FromSqlResult<Self>

Converts SQLite value into Rust value.

impl Hash for Guid

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Ord for Guid

fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<'a> PartialEq<&'a [u8]> for Guid

fn eq(&self, other: &&'a [u8]) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<&'a str> for Guid

fn eq(&self, other: &&'a str) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<[u8]> for Guid

fn eq(&self, other: &[u8]) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Guid> for Guid

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Guid> for str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Guid> for &'a str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Guid> for String

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Guid> for [u8]

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Guid> for &'a [u8]

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Guid> for Vec<u8>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<String> for Guid

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Vec<u8>> for Guid

fn eq(&self, other: &Vec<u8>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<str> for Guid

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Guid> for Guid

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Guid

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl ToSql for Guid

fn to_sql(&self) -> Result<ToSqlOutput<'_>>

Converts Rust value to SQLite value