Development Documentation (main branch) - For stable release docs, see docs.rs/eidetica
Skip to main content

InstanceAdmin

Struct InstanceAdmin 

Source
pub struct InstanceAdmin<'a> { /* private fields */ }
Expand description

Instance-admin capability view over a User session.

Obtain via User::admin. See the module docs for the rationale behind the separate type.

Implementations§

Source§

impl<'a> InstanceAdmin<'a>

Source

pub async fn create_user(&self, new_user: NewUser) -> Result<String>

Create a new user account.

Signs the _users write with this admin’s session key and authors the new user’s database via the regular Database::create wire path. The user-tree first-login bootstrap (root UserKey row, device-key Read grant) is deferred to first login, where the new user is themselves the connection session and can author both writes directly. The result is the same one code path on local and remote instances — no daemon-side RPC and no plaintext password on the wire.

Returns the new user’s UUID (stable internal identifier). Use Instance::login_user to obtain a User session for the new account; materialising it directly here would require the admin’s connection to read the new user’s own tree over the wire, where the session gate (correctly) rejects the admin as a non-member.

§Arguments
  • new_user - Username and optional password for the user to create. See NewUser.
Source

pub async fn list_users(&self) -> Result<Vec<String>>

List all user IDs.

Reads _users via the admin’s session key, so it works on both local and remote instances.

Source

pub async fn grant_instance_admin(&self, new_admin: &PublicKey) -> Result<()>

Grant instance-admin to another key.

Adds new_admin as Admin(0) on the system databases that gate instance-level admin operations (_users and _databases), with the write signed by this admin’s own key. The first instance admin is created automatically during instance bootstrap; this is how every subsequent admin is promoted.

Idempotent: re-granting an existing admin re-asserts the same Admin(0) entry.

Trait Implementations§

Source§

impl<'a> Debug for InstanceAdmin<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for InstanceAdmin<'a>

§

impl<'a> !RefUnwindSafe for InstanceAdmin<'a>

§

impl<'a> Send for InstanceAdmin<'a>

§

impl<'a> Sync for InstanceAdmin<'a>

§

impl<'a> Unpin for InstanceAdmin<'a>

§

impl<'a> UnsafeUnpin for InstanceAdmin<'a>

§

impl<'a> !UnwindSafe for InstanceAdmin<'a>

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
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

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
§

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> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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