Struct CiphersClient 

pub struct CiphersClient(pub(crate) CiphersClient);

Tuple Fields

0: CiphersClient

Implementations

impl CiphersClient

pub async fn encrypt( &self, cipher_view: CipherView, ) -> Result<EncryptionContext>

Encrypt cipher

pub async fn decrypt(&self, cipher: Cipher) -> Result<CipherView>

Decrypt cipher

pub async fn decrypt_list( &self, ciphers: Vec<Cipher>, ) -> Result<Vec<CipherListView>>

Decrypt cipher list

pub async fn encrypt_list( &self, cipher_views: Vec<CipherView>, ) -> Result<Vec<EncryptionContext>>

Encrypt a list of cipher views. Fails if any cipher fails to encrypt.

pub async fn decrypt_list_with_failures( &self, ciphers: Vec<Cipher>, ) -> Result<DecryptCipherListResult>

Decrypt cipher list with failures Returns both successfully decrypted ciphers and any that failed to decrypt

pub fn move_to_organization( &self, cipher: CipherView, organization_id: OrganizationId, ) -> Result<CipherView>

Move a cipher to an organization, reencrypting the cipher key if necessary

pub async fn prepare_ciphers_for_bulk_share( &self, ciphers: Vec<CipherView>, organization_id: OrganizationId, collection_ids: Vec<CollectionId>, ) -> Result<Vec<EncryptionContext>>

Prepare ciphers for bulk share to an organization

pub async fn decrypt_list_full_with_failures( &self, ciphers: Vec<Cipher>, ) -> Result<DecryptCipherResult>

Decrypt full cipher list Returns both successfully fully decrypted ciphers and any that failed to decrypt

pub async fn create(&self, request: CipherCreateRequest) -> Result<CipherView>

Create a new cipher and save it to the server and local state

pub async fn edit(&self, request: CipherEditRequest) -> Result<CipherView>

Edit an existing cipher and save it to the server and local state

pub async fn edit_gated( &self, request: CipherEditRequest, original_cipher_view: CipherView, ) -> Result<CipherView>

Edit a PAM-gated cipher whose secrets were revealed under an active lease.

Pass the full view obtained from the lease-authorised read as original_cipher_view. The returned view is partial, since the server withholds secrets from a gated write-return.

pub async fn edit_partial( &self, request: CipherPartialEditRequest, ) -> Result<CipherView>

Update only the folder and favorite status of a cipher, for users without edit permission

pub async fn update_collection( &self, cipher_id: CipherId, collection_ids: Vec<CollectionId>, ) -> Result<CipherView>

Update the collections a cipher belongs to

pub async fn get(&self, cipher_id: CipherId) -> Result<CipherView>

Get a cipher from local state and decrypt it

pub async fn list(&self) -> Result<DecryptCipherListResult>

Get all ciphers from local state and decrypt them to list views, returning both successes and failures

pub async fn get_all(&self) -> Result<DecryptCipherResult>

Get all ciphers from local state and fully decrypt them, returning both successes and failures

pub async fn delete(&self, cipher_id: CipherId) -> Result<()>

Permanently delete a cipher from the server and local state

pub async fn delete_many( &self, cipher_ids: Vec<CipherId>, organization_id: Option<OrganizationId>, ) -> Result<()>

Permanently delete multiple ciphers from the server and local state

pub async fn soft_delete(&self, cipher_id: CipherId) -> Result<()>

Move a cipher to the trash

pub async fn soft_delete_many( &self, cipher_ids: Vec<CipherId>, organization_id: Option<OrganizationId>, ) -> Result<()>

Move multiple ciphers to the trash

pub async fn restore(&self, cipher_id: CipherId) -> Result<CipherView>

Restore a cipher from the trash

pub async fn restore_many( &self, cipher_ids: Vec<CipherId>, ) -> Result<DecryptCipherListResult>

Restore multiple ciphers from the trash

pub async fn share_cipher( &self, cipher_view: CipherView, organization_id: OrganizationId, collection_ids: Vec<CollectionId>, original_cipher_view: Option<CipherView>, ) -> Result<CipherView>

Share a cipher with an organization, re-encrypting it with the organization key

pub async fn share_ciphers_bulk( &self, cipher_views: Vec<CipherView>, organization_id: OrganizationId, collection_ids: Vec<CollectionId>, ) -> Result<Vec<CipherView>>

Share multiple ciphers with an organization, re-encrypting them with the organization key

pub async fn move_many( &self, cipher_ids: Vec<CipherId>, folder_id: Option<FolderId>, ) -> Result<()>

Move multiple ciphers to a folder, or out of any folder when folder_id is None

pub async fn bulk_update_collections( &self, organization_id: OrganizationId, cipher_ids: Vec<CipherId>, collection_ids: Vec<CollectionId>, remove_collections: bool, ) -> Result<()>

Add or remove collections for multiple organization ciphers

Trait Implementations

impl<UT> LiftRef<UT> for CiphersClient

type LiftType = Arc<CiphersClient>

impl<UT> LowerError<UT> for CiphersClient

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for CiphersClient

type ReturnType = <Arc<CiphersClient> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for CiphersClient

const TYPE_ID_META: MetadataBuffer