[][src]Struct ironoxide::IronOxide

pub struct IronOxide { /* fields omitted */ }

Primary SDK Object

Struct that is used to make authenticated requests to the IronCore API. Instantiated with the details of an account's various ids, device, and signing keys. Once instantiated all operations will be performed in the context of the account provided.


impl IronOxide[src]

pub fn device(&self) -> &DeviceContext[src]

DeviceContext that was used to create this SDK instance

pub fn clear_policy_cache(&self) -> usize[src]

Clears all entries from the policy cache.

Returns the number of entries cleared from the cache.

pub async fn rotate_all(
    rotations: &PrivateKeyRotationCheckResult,
    password: &str,
    timeout: Option<Duration>
) -> Result<(Option<UserUpdatePrivateKeyResult>, Option<Vec<GroupUpdatePrivateKeyResult>>)>

Rotate the private key of the calling user and all groups they are an administrator of where needs_rotation is true. Note that this function has the potential to take much longer than other functions, as rotation will be done individually on each user/group. If rotation is only needed for a specific group, it is strongly recommended to call user_rotate_private_key or group_rotate_private_key instead.


  • rotations - PrivateKeyRotationCheckResult that holds all users and groups to be rotated
  • password - Password to unlock the current user's user master key
  • timeout - timeout for rotate_all. This is a separate timeout from the SDK-wide timeout as it is expected that this operation might take significantly longer than other operations.

Trait Implementations

impl BlindIndexSearchInitialize for IronOxide[src]

impl Debug for IronOxide[src]

Manual implementation of Debug without the recrypt or rng fields

impl DocumentAdvancedOps for IronOxide[src]

impl DocumentOps for IronOxide[src]

impl GroupOps for IronOxide[src]

impl UserOps for IronOxide[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,