Struct autopush_common::db::UserBuilder

pub struct UserBuilder { /* private fields */ }

Builder for User.

Implementations

impl UserBuilder

pub fn uaid(&mut self, value: Uuid) -> &mut Self

The UAID. This is generally a UUID4. It needs to be globally unique.

pub fn connected_at(&mut self, value: u64) -> &mut Self

Time in milliseconds that the user last connected at

pub fn router_type(&mut self, value: String) -> &mut Self

Router type of the user

pub fn router_data(&mut self, value: HashMap<String, Value>) -> &mut Self

Router-specific data

pub fn node_id(&mut self, value: String) -> &mut Self

Last node/port the client was or may be connected to

pub fn record_version(&mut self, value: u64) -> &mut Self

Record version

pub fn current_timestamp(&mut self, value: u64) -> &mut Self

the timestamp of the last notification sent to the user This field is exclusive to the Bigtable data scheme

pub fn version(&mut self, value: Uuid) -> &mut Self

UUID4 version number for optimistic locking of updates on Bigtable

pub fn priv_channels(&mut self, value: HashSet<Uuid>) -> &mut Self

Set of user’s channel ids. These are stored in router (user) record’s row in Bigtable. They are read along with the rest of the user record so that them, along with every other field in the router record, will automatically have their TTL (cell timestamp) reset during [DbClient::update_user].

This is solely used for the sake of that update thus private. [DbClient::get_channels] is preferred for reading the latest version of the channel ids (partly due to historical purposes but also is a more flexible API that might benefit different, non Bigtable [DbClient] backends that don’t necessarily store the channel ids in the router record).

pub fn build(&self) -> Result<User, UserBuilderError>

Builds a new User.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for UserBuilder

fn clone(&self) -> UserBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for UserBuilder

fn default() -> Self

Returns the “default value” for a type.