Struct seaplane_cli::api::LocksReq

pub struct LocksReq { /* private fields */ }

Wraps an SDK LocksRequest where we do additional things like re-use request access tokens, allow changing the Locks this request is pointed to, and map errors appropriately.

Implementations

impl LocksReq

pub fn new(ctx: &Ctx) -> Result<Self>

pub fn set_identifiers<S: Into<String>>(
    &mut self,
    name: Option<LockName>,
    lock_id: Option<S>
) -> Result<()>

pub fn set_name(&mut self, name: LockName) -> Result<()>

pub fn refresh_token(&mut self) -> Result<()>

Request a new Access Token

pub fn token_or_refresh(&mut self) -> Result<&str>

Retrieves the JWT access token, requesting a new one if required.

pub fn get_page(
    &mut self,
    next_key: Option<LockName>,
    dir: Option<LockName>
) -> Result<LockInfoRange>

Gets a page of held locks from dir if present (or the root) if not, optionally starting from next_key

impl LocksReq

pub fn acquire(&mut self, ttl: u32, client_id: &str) -> Result<HeldLockModel>

pub fn release(&mut self) -> Result<()>

pub fn renew(&mut self, ttl: u32) -> Result<()>

pub fn get_lock_info(&mut self) -> Result<LockInfoModel>

Trait Implementations

impl Debug for LocksReq

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

Formats the value using the given formatter.