Struct ironoxide::blocking::BlockingIronOxide

pub struct BlockingIronOxide { /* fields omitted */ }

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. Identical to IronOxide but also contains a Runtime.

Implementations

impl BlockingIronOxide

pub fn device(&self) -> &DeviceContext

Get the DeviceContext instance that was used to create this SDK instance

pub fn clear_policy_cache(&self) -> usize

See ironoxide::IronOxide::clear_policy_cache

pub fn create_blind_index(
    &self,
    group_id: &GroupId
) -> Result<EncryptedBlindIndexSalt>

See ironoxide::IronOxide::create_blind_index

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

See ironoxide::IronOxide::rotate_all

pub fn document_list(&self) -> Result<DocumentListResult>

See ironoxide::document::DocumentOps::document_list

pub fn document_get_metadata(
    &self,
    id: &DocumentId
) -> Result<DocumentMetadataResult>

See ironoxide::document::DocumentOps::document_get_metadata

pub fn document_get_id_from_bytes(
    &self,
    encrypted_document: &[u8]
) -> Result<DocumentId>

See ironoxide::document::DocumentOps::document_get_id_from_bytes

pub fn document_encrypt(
    &self,
    document_data: &[u8],
    encrypt_opts: &DocumentEncryptOpts
) -> Result<DocumentEncryptResult>

See ironoxide::document::DocumentOps::document_encrypt

pub fn document_update_bytes(
    &self,
    id: &DocumentId,
    new_document_data: &[u8]
) -> Result<DocumentEncryptResult>

See ironoxide::document::DocumentOps::document_update_bytes

pub fn document_decrypt(
    &self,
    encrypted_document: &[u8]
) -> Result<DocumentDecryptResult>

See ironoxide::document::DocumentOps::document_decrypt

pub fn document_update_name(
    &self,
    id: &DocumentId,
    name: Option<&DocumentName>
) -> Result<DocumentMetadataResult>

See ironoxide::document::DocumentOps::document_update_name

pub fn document_grant_access(
    &self,
    id: &DocumentId,
    grant_list: &Vec<UserOrGroup>
) -> Result<DocumentAccessResult>

See ironoxide::document::DocumentOps::document_grant_access

pub fn document_revoke_access(
    &self,
    id: &DocumentId,
    revoke_list: &Vec<UserOrGroup>
) -> Result<DocumentAccessResult>

See ironoxide::document::DocumentOps::document_revoke_access

pub fn document_encrypt_unmanaged(
    &self,
    data: &[u8],
    encrypt_opts: &DocumentEncryptOpts
) -> Result<DocumentEncryptUnmanagedResult>

See ironoxide::document::advanced::DocumentAdvancedOps::document_encrypt_unmanaged

pub fn document_decrypt_unmanaged(
    &self,
    encrypted_data: &[u8],
    encrypted_deks: &[u8]
) -> Result<DocumentDecryptUnmanagedResult>

See ironoxide::document::advanced::DocumentAdvancedOps::document_decrypt_unmanaged

pub fn group_list(&self) -> Result<GroupListResult>

See ironoxide::group::GroupOps::group_list

pub fn group_create(&self, opts: &GroupCreateOpts) -> Result<GroupCreateResult>

See ironoxide::group::GroupOps::group_create

pub fn group_get_metadata(&self, id: &GroupId) -> Result<GroupGetResult>

See ironoxide::group::GroupOps::group_get_metadata

pub fn group_delete(&self, id: &GroupId) -> Result<GroupId>

See ironoxide::group::GroupOps::group_delete

pub fn group_update_name(
    &self,
    id: &GroupId,
    name: Option<&GroupName>
) -> Result<GroupMetaResult>

See ironoxide::group::GroupOps::group_update_name

pub fn group_add_members(
    &self,
    id: &GroupId,
    grant_list: &[UserId]
) -> Result<GroupAccessEditResult>

See ironoxide::group::GroupOps::group_add_members

pub fn group_remove_members(
    &self,
    id: &GroupId,
    revoke_list: &[UserId]
) -> Result<GroupAccessEditResult>

See ironoxide::group::GroupOps::group_remove_members

pub fn group_add_admins(
    &self,
    id: &GroupId,
    users: &[UserId]
) -> Result<GroupAccessEditResult>

See ironoxide::group::GroupOps::group_add_admins

pub fn group_remove_admins(
    &self,
    id: &GroupId,
    revoke_list: &[UserId]
) -> Result<GroupAccessEditResult>

See ironoxide::group::GroupOps::group_remove_admins

pub fn group_rotate_private_key(
    &self,
    id: &GroupId
) -> Result<GroupUpdatePrivateKeyResult>

See ironoxide::group::GroupOps::group_rotate_private_key

pub fn user_create(
    jwt: &Jwt,
    password: &str,
    user_create_opts: &UserCreateOpts,
    timeout: Option<Duration>
) -> Result<UserCreateResult>

See ironoxide::user::UserOps::user_create

pub fn user_list_devices(&self) -> Result<UserDeviceListResult>

See ironoxide::user::UserOps::user_list_devices

pub fn generate_new_device(
    jwt: &Jwt,
    password: &str,
    device_create_options: &DeviceCreateOpts,
    timeout: Option<Duration>
) -> Result<DeviceAddResult>

See ironoxide::user::UserOps::generate_new_device

pub fn user_delete_device(
    &self,
    device_id: Option<&DeviceId>
) -> Result<DeviceId>

See ironoxide::user::UserOps::user_delete_device

pub fn user_verify(
    jwt: &Jwt,
    timeout: Option<Duration>
) -> Result<Option<UserResult>>

See ironoxide::user::UserOps::user_verify

pub fn user_get_public_key(
    &self,
    users: &[UserId]
) -> Result<HashMap<UserId, PublicKey>>

See ironoxide::user::UserOps::user_get_public_key

pub fn user_rotate_private_key(
    &self,
    password: &str
) -> Result<UserUpdatePrivateKeyResult>

See ironoxide::user::UserOps::user_rotate_private_key

Trait Implementations

impl Debug for BlockingIronOxide

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

Formats the value using the given formatter.