Struct Scope

pub struct Scope { /* private fields */ }

Used to scope a Key. Consists of a vector of zero or more SegmentBufs.

Implementations

impl Scope

pub const SEPARATOR: char = '/'

Character used to split on when parsing a Scope from a string.

pub fn from_segment(segment: impl Into<SegmentBuf>) -> Scope

Create a Scope from a single Segment.

Example

use kvx_types::{Scope, Segment};

Scope::from_segment(Segment::parse("segment")?);

pub fn global() -> Scope

Create an empty Scope.

Example

use kvx_types::Scope;

Scope::global();

pub fn new(segments: Vec<SegmentBuf>) -> Scope

Create a Scope from a vector of SegmentBufs.

Example

use kvx_types::{Scope, Segment};

Scope::new(vec![Segment::parse("segment1")?.to_owned(), Segment::parse("segment2")?.to_owned()]);

pub fn as_vec(&self) -> &Vec<SegmentBuf>

Returns the underlying vector of SegmentBufs.

pub fn len(&self) -> i32

Returns the length of the underlying vector.

pub fn is_global(&self) -> bool

Returns whether the underlying vector is empty.

pub fn matches(&self, other: &Scope) -> bool

Two scopes match if the longest of the two contains all Segments of the other.

pub fn starts_with(&self, prefix: &Scope) -> bool

Returns whether the encapsulated vector starts with a certain prefix.

pub fn sub_scopes(&self) -> Vec<Scope>

Returns a vector of all prefixes of the scope.

pub fn with_sub_scope(&self, sub_scope: impl Into<SegmentBuf>) -> Scope

Create a new Scope and add a Segment to the end of it.

pub fn add_sub_scope(&mut self, sub_scope: impl Into<SegmentBuf>)

Add a Segment to the end of the scope.

pub fn with_super_scope(&self, super_scope: impl Into<SegmentBuf>) -> Scope

Create a new Scope and add a Segment to the front of it.

pub fn add_super_scope(&mut self, super_scope: impl Into<SegmentBuf>)

Add a Segment to the front of the scope.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl Default for Scope

fn default() -> Scope

Returns the “default value” for a type.

impl Display for Scope

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

Formats the value using the given formatter.

impl Extend<SegmentBuf> for Scope

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = SegmentBuf>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl From<Vec<SegmentBuf>> for Scope

fn from(segments: Vec<SegmentBuf>) -> Scope

Converts to this type from the input type.

impl FromIterator<SegmentBuf> for Scope

fn from_iter<T>(iter: T) -> Scope

where T: IntoIterator<Item = SegmentBuf>,

Creates a value from an iterator.

impl<'a> FromSql<'a> for Scope

fn from_sql( _type: &Type, buf: &'a [u8], ) -> Result<Scope, Box<dyn Error + Sync + Send>>

Creates a new value of this type from a buffer of data of the specified Postgres Type in its binary format.

fn accepts(type_: &Type) -> bool

Determines if a value of this type can be created from the specified Postgres Type.

fn from_sql_null(ty: &Type) -> Result<Self, Box<dyn Error + Sync + Send>>

Creates a new value of this type from a NULL SQL value.

fn from_sql_nullable( ty: &Type, raw: Option<&'a [u8]>, ) -> Result<Self, Box<dyn Error + Sync + Send>>

A convenience function that delegates to from_sql and from_sql_null depending on the value of raw.

impl FromStr for Scope

type Err = ParseSegmentError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Scope, <Scope as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Scope

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a Scope

type IntoIter = <&'a Vec<SegmentBuf> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

type Item = <&'a Vec<SegmentBuf> as IntoIterator>::Item

The type of the elements being iterated over.

fn into_iter(self) -> <&'a Scope as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for Scope

type IntoIter = <Vec<SegmentBuf> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

type Item = <Vec<SegmentBuf> as IntoIterator>::Item

The type of the elements being iterated over.

fn into_iter(self) -> <Scope as IntoIterator>::IntoIter

Creates an iterator from a value.

impl Ord for Scope

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Scope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Scope

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl ToSql for Scope

fn to_sql( &self, _type: &Type, buf: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Converts the value of self into the binary format of the specified Postgres Type, appending it to out.

fn accepts(type_: &Type) -> bool

Determines if a value of this type can be converted to the specified Postgres Type.

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

An adaptor method used internally by Rust-Postgres.

fn encode_format(&self, _ty: &Type) -> Format

Specify the encode format

impl Eq for Scope

impl StructuralPartialEq for Scope