Struct twitch_api_rs::auth::scopes::ScopeSet

pub struct ScopeSet { /* fields omitted */ }

Represents a set of scopes available with a specific bearer auth key

Implementations

impl ScopeSet

pub fn new() -> Self

Create a new empty set of scopes

pub fn get(&self, bit: usize) -> bool

Get whether this type contains a single scope

pub fn set(&mut self, bit: usize, val: bool) -> bool

Set a bit for a single scope, returns the old value

pub fn contains(&self, scope: &str) -> bool

Returns true if the set contains the scope specified
Returns false if it does not or the scope does not exist

let mut scopes = ScopeSet::new();

scopes.set(2, true);

assert!(scopes.contains("bits:read"));

assert!(!scopes.contains("channel:edit:commercial"));

pub fn iter<'a>(&'a self) -> ScopesIter<'a>

Get an iterator over scopes idents iterator

pub fn ident_to(a: &usize) -> Option<&'static str>

Identity function for converting between scope internal number and twitch token string

pub fn ident_from(b: &str) -> Option<&'static usize>

Identity function for converting between scope internal number and twitch token string

Trait Implementations

impl Clone for ScopeSet

fn clone(&self) -> ScopeSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScopeSet

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

Formats the value using the given formatter.

impl<'a> FromIterator<&'a str> for ScopeSet

fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a ScopeSet

type Item = &'static str

The type of the elements being iterated over.

type IntoIter = ScopesIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> ScopesIter<'a>

Creates an iterator from a value.