Struct ConnectorDescriptor 

pub struct ConnectorDescriptor {
    pub id: ConnectorId,
    pub display_name: String,
    pub auth: AuthKind,
    pub required_permissions: Vec<ProductPermission>,
    pub supports_multiple_accounts: bool,
}

What a connector is.

Kept separate from the trait so it can be rendered in a settings UI, serialised into the app manifest, and reviewed without instantiating anything.

Fields

id: ConnectorId

display_name: String

auth: AuthKind

required_permissions: Vec<ProductPermission>

The rights this connector needs at the external service.

Declared, not inferred: a reviewer can see in one place whether an integration asks for write access, and a product can refuse to ship one that does.

supports_multiple_accounts: bool

Whether the user may connect several accounts (ADR-0016).

Implementations

impl ConnectorDescriptor

pub fn new( id: ConnectorId, display_name: impl Into<String>, auth: AuthKind, ) -> Self

pub fn with_permissions( self, permissions: impl IntoIterator<Item = ProductPermission>, ) -> Self

pub fn single_account(self) -> Self

pub fn requests_write_access(&self) -> bool

Whether this connector asks for any write access.

Products that want to stay read-only assert on this in a test.

Trait Implementations

impl Clone for ConnectorDescriptor

fn clone(&self) -> ConnectorDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectorDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConnectorDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ConnectorDescriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.