Skip to main content

AuthoringPermit

Struct AuthoringPermit 

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

A borrowed decision, deliberately neither Clone nor Serialize. It is usable only while the host holds current state. Reauthorize every action; do not cache permits or release the owner lock before the operation commits.

Implementations§

Source§

impl AuthoringPermit<'_>

Source

pub fn action(&self) -> AuthoringAction

Source

pub fn principal_subject(&self) -> &str

Source

pub fn target(&self) -> &DocumentRevision

Source

pub fn authority_generation(&self) -> u64

Source§

impl AuthoringPermit<'_>

Source

pub fn contribution_record( self, id: &str, description: &str, effort_minutes: u32, work_status: WorkStatus, predecessor: Option<&ContributionRecord>, ) -> Result<ContributionRecord, AuthoringError>

Call only after authoring succeeded, while the host’s transaction still owns this current revision. The owner persists/deduplicates this record atomically with its source journal. Caller cannot attribute another author.

Source

pub fn review_record( self, id: &str, decision: ReviewDecision, rationale: &str, decision_evidence_ref: &str, ) -> Result<ReviewRecord, AuthoringError>

Trait Implementations§

Source§

impl<'a> Debug for AuthoringPermit<'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 AuthoringPermit<'a>

§

impl<'a> RefUnwindSafe for AuthoringPermit<'a>

§

impl<'a> Send for AuthoringPermit<'a>

§

impl<'a> Sync for AuthoringPermit<'a>

§

impl<'a> Unpin for AuthoringPermit<'a>

§

impl<'a> UnsafeUnpin for AuthoringPermit<'a>

§

impl<'a> UnwindSafe for AuthoringPermit<'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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.