Skip to main content

stamp_retired

Function stamp_retired 

pub fn stamp_retired(
    doc: &mut AutoCommit,
    why: &Retirement,
) -> Result<(), TransferError>
Expand description

Stamp doc retired, in one change of its own, unless it already is. The shell does this to a record at rest; an app does it to the live document it shows, so the stamp travels to everyone holding that record over its normal route.

ยงErrors

A document whose metadata cannot hold the stamp.