Struct elefren::scopes::Scopes

pub struct Scopes { /* fields omitted */ }

Represents a set of OAuth scopes

Example

use elefren::prelude::*;

let read = Scopes::read_all();
let write = Scopes::write_all();
let follow = Scopes::follow();
let all = read | write | follow;

Methods

impl Scopes

pub fn all() -> Scopes

Represents all available oauth scopes: "read write follow push"

use elefren::scopes::Scopes;

let scope = Scopes::all();
assert_eq!(&format!("{}", scope), "read write follow push");

pub fn read_all() -> Scopes

Represents the full "read" scope

use elefren::scopes::Scopes;

let scope = Scopes::read_all();
assert_eq!(&format!("{}", scope), "read");

pub fn read(subscope: Read) -> Scopes

Represents a specific "read:___" scope

use elefren::scopes::{Read, Scopes};

let scope = Scopes::read(Read::Accounts);
assert_eq!(&format!("{}", scope), "read:accounts");

pub fn write_all() -> Scopes

Represents the full "write" scope

use elefren::scopes::Scopes;

let scope = Scopes::write_all();
assert_eq!(&format!("{}", scope), "write");

pub fn write(subscope: Write) -> Scopes

Represents a specific "write:___" scope

use elefren::scopes::{Scopes, Write};

let scope = Scopes::write(Write::Accounts);
assert_eq!(&format!("{}", scope), "write:accounts");

pub fn follow() -> Scopes

Represents the "follow" scope

use elefren::scopes::Scopes;

let scope = Scopes::follow();
assert_eq!(&format!("{}", scope), "follow");

pub fn push() -> Scopes

Represents the full "push" scope

use elefren::scopes::Scopes;

let scope = Scopes::push();
assert_eq!(&format!("{}", scope), "push");

pub fn and(self, other: Scopes) -> Scopes

Combines 2 scopes together

Example

use elefren::prelude::*;

let read = Scopes::read_all();
let write = Scopes::write_all();
let read_write = read.and(write);

Trait Implementations

impl PartialEq<Scopes> for Scopes

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

fn default() -> Scopes

Returns the "default value" for a type.

impl Clone for Scopes

fn clone(&self) -> Scopes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Scopes

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

Formats the value using the given formatter.

impl Debug for Scopes

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

Formats the value using the given formatter.

impl BitOr<Scopes> for Scopes

type Output = Scopes

The resulting type after applying the | operator.

fn bitor(self, other: Scopes) -> Self::Output

Performs the | operation.

impl FromStr for Scopes

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Scopes, Self::Err>

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

impl Serialize for Scopes

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

Serialize this value into the given Serde serializer.