Struct merino_adm::remote_settings::connection_pool::Connection

pub struct Connection<'a> {
    pub client: Option<Client>,
    pool: &'a ConnectionPool,
}

The connection to Remote Settings

Fields

client: Option<Client>

The wrapped connection to Remote Settings.

pool: &'a ConnectionPool

A reference to the pool, used internally for pool management.

Methods from Deref<Target = Client>

pub async fn get(&mut self) -> Result<Vec<Record, Global>, ClientError>

Return the records stored locally.

Examples

match client.get().await {
  Ok(records) => println!("{:?}", records),
  Err(error) => println!("Error fetching/verifying records: {:?}", error)
};

Behaviour

• Return local data by default;
• If local data is empty and if sync_if_empty is true (default), then synchronize the local data with the server and return records, otherwise return an error.

Note: with the DummyStorage, any call to .get() will trigger a synchronization.

Note: with sync_if_empty as false, if .sync() is never called then .get() will always return an error.

Errors

If an error occurs while fetching or verifying records, a ClientError is returned.

pub async fn sync<T>(&mut self, expected: T) -> Result<Collection, ClientError> where
    T: Into<Option<u64>>, 

Synchronize the local storage with the content of the server for this collection.

Behaviour

• If stored data is up-to-date and signature of local data valid, then return local content;
• Otherwise fetch content from server, merge with local content, verify signature, and return records;

Errors

If an error occurs while fetching or verifying records, a ClientError is returned.

pub async fn server_info(&mut self) -> Result<&Value, ClientError>

pub async fn fetch_attachment<T, E>(
    &mut self,
    record: &mut Record
) -> Result<Option<T>, ClientError> where
    T: TryFrom<Vec<u8, Global>, Error = E>,
    E: 'static + Send + Sync + Error, 

Download the attachment for a record.

Return values:

• Ok(Some(T)) - There is an attachment for the record and it was successfully downloaded.
• Err(_) - There is an attachment for the record, and there was a problem while downloading it. This should be considered a temporary error.
• Ok(None) - There is no attachment for the record

pub async fn store_record(&self, record: Record) -> Result<Value, ClientError>

Store a record on the server.

Arguments

• record - the record to store.

pub async fn delete_record(&self, id: &str) -> Result<Value, ClientError>

Delete a record from the server.

Arguments

• id - the record id to delete.

pub async fn request_review(&self, message: &str) -> Result<Value, ClientError>

Request review from configured reviewers.

Arguments

• message - the editor message.

pub async fn reject_review(&self, message: &str) -> Result<Value, ClientError>

Reject review.

Arguments

• message - the editor message.

pub async fn approve_changes(&self) -> Result<Value, ClientError>

Approve and publish changes.

pub async fn rollback_changes(&self) -> Result<Value, ClientError>

Rollback pending changes.

Trait Implementations

impl Deref for Connection<'_>

type Target = Client

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Connection<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for Connection<'_>

fn drop(&mut self)

Executes the destructor for this type.