Struct PlmClient 

pub struct PlmClient { /* private fields */ }

One PLM server, and who the app is on it.

Implementations

impl PlmClient

pub fn new(transport: Rc<dyn PlmTransport>) -> Self

pub fn me(&self) -> Option<Me>

Who the client is signed in as, once a sign-in has passed the version check.

pub fn credential(&self) -> Credential

pub fn forget(&self)

Forget the credential locally. (A token stays valid on the server; the user revokes it on the PLM’s page.)

pub async fn raw( &self, method: &'static str, path: &str, body: Option<Vec<u8>>, ) -> Result<PlmResponse, PlmError>

One call with the current credential. Every status comes back Ok; only a request that got no answer is an Err.

pub async fn sign_in_with_token(&self, token: &str) -> Result<Me, PlmError>

Sign in with a token (pasted, or read from plm-token). Passes only if the server accepts the token AND its version serves this app.

pub async fn sign_in_with_browser_session(&self) -> Result<Me, PlmError>

The page is served by the PLM and the browser already holds a session cookie (D6): adopt it, and read the CSRF token changes must carry.

pub async fn sign_in_with_password( &self, username: &str, password: &str, ) -> Result<Me, PlmError>

Sign in with a username and password as a SESSION (the web lane, D6).

pub async fn sign_in_for_token( &self, username: &str, password: &str, token_name: &str, ) -> Result<(Me, String), PlmError>

Trade a username and password for a token (the native lane, D5): sign in, mint a full token named token_name through that session, sign the session out, and sign in with the token. Returns the token for the caller to keep (plm::config::write_token); the password is not kept.

pub async fn index(&self) -> Result<StoreIndex, PlmError>

GET /api/store/index.

pub async fn index_rows(&self, keys: &[String]) -> Result<StoreIndex, PlmError>

GET /api/store/index?keys=…: only those revisions’ rows (a key that names no revision any more is absent from the answer).

pub async fn get_document(&self, key: &str) -> Result<Option<Vec<u8>>, PlmError>

GET /api/store/doc/<key>: the bytes, or None when the revision has no document yet (204). A revision that does not exist is PlmError::NotFound.

pub async fn put_document( &self, key: &str, bytes: Vec<u8>, ) -> Result<PutAck, PlmError>

PUT /api/store/doc/<key>. Needs the lock and an editable revision; otherwise PlmError::Conflict with the server’s sentence.

pub async fn delete_document(&self, key: &str) -> Result<(), PlmError>

DELETE /api/store/doc/<key>, under the same two conditions as a write.

pub async fn get_preference( &self, name: &str, ) -> Result<Option<String>, PlmError>

GET /api/me/preferences/<name> (@settings, …): the value, or None when the user has never set it. Unset is 204 No Content (server B, 2026-09-25: a hosted page’s console logs every 404) and was 404 before; both read as unset.

pub async fn put_preference( &self, name: &str, value: String, ) -> Result<(), PlmError>

PUT /api/me/preferences/<name> with the value, which must be JSON.

pub async fn delete_preference(&self, name: &str) -> Result<(), PlmError>

DELETE /api/me/preferences/<name>; deleting an unset one is fine.

pub async fn changes(&self, since: u64) -> Result<Changes, PlmError>

GET /api/store/changes?since=<seq>.