Skip to main content

CloudKitClient

Struct CloudKitClient 

Source
pub struct CloudKitClient { /* private fields */ }

Implementations§

Source§

impl CloudKitClient

Source

pub fn new(auth: AuthConfig) -> Result<Self>

Source

pub fn modify(&self, ops: Vec<ModifyOperation>) -> Result<Vec<CkRecord>>

Source

pub fn modify_in_zone( &self, zone_id: ZoneId, ops: Vec<ModifyOperation>, ) -> Result<Vec<CkRecord>>

Source

pub fn query(&self, req: QueryRequest) -> Result<QueryResponse>

Source

pub fn list_notes( &self, include_trashed: bool, include_archived: bool, limit: Option<usize>, ) -> Result<Vec<CkRecord>>

Source

pub fn list_phantom_notes(&self, limit: Option<usize>) -> Result<Vec<CkRecord>>

Source

pub fn delete_phantom_notes( &self, records: &[CkRecord], ) -> Result<Vec<CkRecord>>

Source

pub fn list_tags(&self) -> Result<Vec<CkRecord>>

Source

pub fn lookup(&self, record_names: &[&str]) -> Result<Vec<CkRecord>>

Source

pub fn fetch_note(&self, record_name: &str) -> Result<CkRecord>

Fetch a single SFNote by its uniqueIdentifier (which equals its CloudKit recordName).

Source

pub fn fetch_note_by_title( &self, title: &str, include_trashed: bool, include_archived: bool, ) -> Result<CkRecord>

Source

pub fn fetch_tag(&self, record_name: &str) -> Result<CkRecord>

Fetch a single SFNoteTag by its recordName.

Source

pub fn upload_asset( &self, record_name: &str, record_type: &str, data: &[u8], mime_type: &str, ) -> Result<AssetReceipt>

Upload a file to CloudKit asset storage. Returns the receipt to embed in a record field.

Source

pub fn create_note( &self, text: &str, tag_uuids: Vec<String>, tag_names: Vec<String>, ) -> Result<CkRecord>

Create a brand-new note. Returns the created record.

Source

pub fn ensure_tag(&self, title: &str) -> Result<String>

Source

pub fn find_tag_record_name(&self, title: &str) -> Result<Option<CkRecord>>

Source

pub fn resolve_tag_record_names( &self, tag_names: &[String], create_missing: bool, ) -> Result<Vec<String>>

Source

pub fn update_note_text( &self, record_name: &str, new_text: &str, ) -> Result<CkRecord>

Update a note’s text. Fetches the current record first to obtain the recordChangeTag and existing vector clock, then writes back the updated content.

Source

pub fn update_note( &self, record_name: &str, new_text: &str, tag_uuids: Option<Vec<String>>, tag_names: Option<Vec<String>>, ) -> Result<CkRecord>

Source

pub fn attach_file( &self, note_record_name: &str, filename: &str, data: &[u8], position: AttachPosition, ) -> Result<()>

Attach a file to a note. Uploads the asset, creates the file record, and updates the note’s markdown — all in one atomic records/modify call.

Source

pub fn trash_note(&self, record_name: &str) -> Result<()>

Move a note to trash (sets trashed=1, trashedDate=now, increments vector clock).

Source

pub fn archive_note(&self, record_name: &str) -> Result<()>

Archive a note.

Source

pub fn delete_note(&self, record_name: &str) -> Result<()>

Source

pub fn delete_tag(&self, record_name: &str) -> Result<()>

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more