Struct TextEncodedScope 

pub struct TextEncodedScope(/* private fields */);

A scope encoded as a space-delimited list of strings, as defined in RFC 6749, section 1.3.

Note that the syntax specified in the RFC has to be followed:

scope       = scope-token *( SP scope-token )
scope-token = 1*( %x21 / %x23-5B / %x5D-7E )

Example

You can create a TextEncodedScope from a space-separated string:

let scope = TextEncodedScope::try_from("first second third")?;
assert!(scope.elements().eq(["first", "second", "third"]));

It’s also possible to pass in a vector of strings:

let scope = TextEncodedScope::try_from(vec!["first", "second", "third"])?;
assert!(scope.elements().eq(["first", "second", "third"]));
assert!(TextEncodedScope::try_from(vec!["not allowed"]).is_err());

But note that you have to follow the syntax from the RFC (which implicitly specifies that given scopes can’t be empty):

assert!(TextEncodedScope::try_from("can't use \\ or \"").is_err());
assert!(TextEncodedScope::try_from("  no   weird spaces ").is_err());
assert!(TextEncodedScope::try_from(vec![]).is_err());

Implementations

impl TextEncodedScope

pub fn elements(&self) -> impl Iterator<Item = &str>

Return the individual elements (i.e., access ranges) of this scope.

Post-condition: The returned iterator will not be empty, and none of its elements may contain spaces ( ), double-quotes (") or backslashes (\\').

Example

let simple = TextEncodedScope::try_from("this is a test")?;
assert!(simple.elements().eq(vec!["this", "is", "a", "test"]));

Trait Implementations

impl Clone for TextEncodedScope

fn clone(&self) -> TextEncodedScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextEncodedScope

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

Formats the value using the given formatter.

impl Display for TextEncodedScope

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

Formats the value using the given formatter.

impl From<TextEncodedScope> for Scope

fn from(value: TextEncodedScope) -> Self

Converts to this type from the input type.

impl Hash for TextEncodedScope

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TextEncodedScope

fn eq(&self, other: &TextEncodedScope) -> 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 Serialize for TextEncodedScope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for TextEncodedScope

type Error = InvalidTextEncodedScopeError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scope> for TextEncodedScope

type Error = WrongSourceTypeError<Scope>

The type returned in the event of a conversion error.

fn try_from(value: Scope) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<&str>> for TextEncodedScope

type Error = InvalidTextEncodedScopeError

The type returned in the event of a conversion error.

fn try_from(value: Vec<&str>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for TextEncodedScope

impl StructuralPartialEq for TextEncodedScope