Struct Scope 

pub struct Scope { /* private fields */ }

A collection of OAuth2 scopes to request access to Xero APIs

Implementations

impl Scope

pub fn new() -> Self

Creates a new empty scope collection

pub fn from_types(scope_types: Vec<ScopeType>) -> Self

Creates a scope collection from a vector of scope types

pub fn from_type(scope_type: ScopeType) -> Self

Creates a scope from a single scope type

pub fn from_string(scope: impl Into<String>) -> Self

Creates a scope from a raw string

pub fn with(self, scope_type: ScopeType) -> Self

Add a scope to this collection

pub fn with_all(self, scope_types: impl IntoIterator<Item = ScopeType>) -> Self

Add multiple scopes to this collection

pub fn combine(self, other: Self) -> Self

Combine with another scope collection

pub fn into_oauth2_scopes(self) -> Vec<OAuth2Scope>

Converts the scopes into a Vec of OAuth2 scopes

pub fn as_oauth2_scopes(&self) -> &[OAuth2Scope]

Get a reference to the contained OAuth2 scopes

pub fn into_oauth2(self) -> OAuth2Scope

Convert this scope collection into a single OAuth2Scope for use with the oauth2 crate

pub fn accounting_transactions() -> Self

Create a scope for full access to transactions

pub fn accounting_transactions_read() -> Self

Create a scope for read-only access to transactions

pub fn accounting_reports_read() -> Self

Create a scope for read-only access to reports

pub fn accounting_reports_tenninetynine_read() -> Self

Create a scope for read-only access to tenninetynine reports

pub fn accounting_budgets_read() -> Self

Create a scope for read-only access to budgets

pub fn accounting_journals_read() -> Self

Create a scope for read-only access to journals

pub fn accounting_settings() -> Self

Create a scope for full access to settings

pub fn accounting_settings_read() -> Self

Create a scope for read-only access to settings

pub fn accounting_contacts() -> Self

Create a scope for full access to contacts

pub fn accounting_contacts_read() -> Self

Create a scope for read-only access to contacts

pub fn accounting_attachments() -> Self

Create a scope for full access to attachments

pub fn accounting_attachments_read() -> Self

Create a scope for read-only access to attachments

pub fn assets() -> Self

Create a scope for full access to assets

pub fn assets_read() -> Self

Create a scope for read-only access to assets

pub fn files() -> Self

Create a scope for full access to files

pub fn files_read() -> Self

Create a scope for read-only access to files

pub fn payroll_employees() -> Self

Create a scope for full access to employees

pub fn payroll_employees_read() -> Self

Create a scope for read-only access to employees

pub fn payroll_payruns() -> Self

Create a scope for full access to payruns

pub fn payroll_payruns_read() -> Self

Create a scope for read-only access to payruns

pub fn payroll_payslip() -> Self

Create a scope for full access to payslips

pub fn payroll_payslip_read() -> Self

Create a scope for read-only access to payslips

pub fn payroll_settings() -> Self

Create a scope for full access to payroll settings

pub fn payroll_settings_read() -> Self

Create a scope for read-only access to payroll settings

pub fn payroll_timesheets() -> Self

Create a scope for full access to timesheets

pub fn payroll_timesheets_read() -> Self

Create a scope for read-only access to timesheets

pub fn projects() -> Self

Create a scope for full access to projects

pub fn projects_read() -> Self

Create a scope for read-only access to projects

pub fn common_accounting_read() -> Self

Shorthand for common accounting scopes (read-only)

pub fn all_accounting_read() -> Self

Shorthand for all accounting scopes (read-only)

pub fn all_accounting() -> Self

Shorthand for all accounting scopes (with read-write permission)

pub fn all_read() -> Self

Shorthand for all scopes (read-only)

pub fn all() -> Self

Shorthand for all scopes (with read-write permission)

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate 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

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

Formats the value using the given formatter.

impl From<Scope> for Scope

fn from(scope: Scope) -> Self

Converts to this type from the input type.

impl From<Scope> for Scope

fn from(scope: OAuth2Scope) -> Self

Converts to this type from the input type.

impl From<ScopeType> for Scope

fn from(scope_type: ScopeType) -> Self

Converts to this type from the input type.

impl From<Vec<ScopeType>> for Scope

fn from(scope_types: Vec<ScopeType>) -> Self

Converts to this type from the input type.

impl FromIterator<ScopeType> for Scope

fn from_iter<I: IntoIterator<Item = ScopeType>>(iter: I) -> Self

Creates a value from an iterator.