Skip to main content

TranscriptArchive

Struct TranscriptArchive 

Source
pub struct TranscriptArchive { /* private fields */ }
Expand description

Redacted zstd copies of transcripts, keyed by source path; an entry is never dropped because its source was deleted, only by remove_where.

Opened sealed, every blob and the removal journal is written under the current key and manifest records go to SEALED_MANIFEST_FILE. Plaintext blobs are read as-is until reseal, and plaintext manifest entries (from before sealing, or appended by an older binary) are folded into the sealed manifest at open, the later of two entries for one source winning.

Implementations§

Source§

impl TranscriptArchive

Source

pub fn open(dir: impl Into<PathBuf>) -> Result<Self>

Source

pub fn open_sealed(dir: impl Into<PathBuf>, keys: SealKeys) -> Result<Self>

Opens the archive writing everything sealed under keys. An archive written before sealing opens as it is; reseal seals what it holds.

Source

pub fn holds_unsealed(&self) -> bool

True while files written in plaintext may remain: plaintext manifest entries were loaded or written, by this process or by one that died before its reseal finished, and no reseal has run since.

Source

pub fn seal_keys(&self) -> Option<SealKeys>

None when the archive writes plaintext.

Source

pub fn set_seal_keys(&self, keys: SealKeys)

Seals what is written from now on under the current key of keys, which must also hold every key the archive’s files are sealed under.

Source

pub fn reseal(&self) -> Result<usize>

Rewrites every blob, the manifest and any removal journal that is plaintext or sealed under a retired key under the current key, and deletes temporary files a crashed write left. Returns how many files were rewritten. Each blob is resealed under the state lock, so a concurrent removal never sees its blob renamed back into place.

Source

pub fn remove_where( &self, doomed: impl Fn(&ArchiveEntry) -> bool, ) -> Result<Vec<ArchiveEntry>>

Drops every entry doomed picks: the blobs to delete are journaled, then the manifest is rewritten, then the blobs go and the journal with them. A crash in between is finished at the next open.

Source

pub fn copy_into(&self, dest: &Path) -> Result<()>

Copies the archive into dest, which must not exist, while archiving goes on. The manifest is appended in place, so it is copied under the state lock; blobs are content-addressed and removed only after the manifest stops naming them, so most are copied without the lock and any the copied manifest no longer names are dropped from the copy.

Source

pub fn holder(&self, sha256: &str) -> Option<ArchiveEntry>

An entry whose blob has this sha256, if any does.

Source

pub fn dir(&self) -> &Path

Source

pub fn archive(&self, source: &Path) -> Result<Archived>

Source

pub fn entry(&self, source: &Path) -> Option<ArchiveEntry>

Source

pub fn read(&self, source: &Path) -> Result<Option<String>>

Source

pub fn entries(&self) -> Vec<ArchiveEntry>

Every archived transcript, in no particular order.

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Auto Trait Implementations§

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
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Fruit for T
where T: Send + Downcast,

Source§

impl<T> Instrument for T

Source§

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

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

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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 = !

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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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