Skip to main content

ObjectReader

Struct ObjectReader 

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

What: A running object reader and the blobs it has already read. Option<ReaderPipes> is “open pipes or nothing”; nothing means closed. Rc<[u8]> is a shared read-only byte list. Why: One value owns the process for its whole life, so the process is always stopped and collected when the value is dropped.

In TS you’d write (pseudocode):

class ObjectReader { #child: ChildProcess; #pipes?: ReaderPipes; #blobs: Map<ObjectId, Uint8Array> }

Implementations§

Source§

impl ObjectReader

What: impl ObjectReader { ... } attaches the read operations, like class methods. Why: Only complete object names and the fixed word HEAD are ever written as requests, so no caller text can inject a second request line.

In TS you’d write (pseudocode):

class ObjectReader { blob(oid) {} headCommit() {} }
Source

pub fn blob(&mut self, object: &ObjectId) -> Result<Rc<[u8]>, CandidateError>

What: The exact bytes of one blob, read once and shared afterwards. Rc::clone(..) makes another handle to the same bytes without copying them. Why: The same blob often backs several paths and several policies; each further use costs neither a request nor a copy.

In TS you’d write (pseudocode):

async blob(oid: ObjectId): Promise<Uint8Array>
Source

pub fn head_commit(&mut self) -> Result<Option<ObjectId>, CandidateError>

What: The commit HEAD names, or nothing when the branch has no commit yet. Option<ObjectId> is “a commit name or nothing”. Why: The staged listing compares against this commit. Asking the running reader costs no further process.

In TS you’d write (pseudocode):

async headCommit(): Promise<ObjectId | undefined>

Trait Implementations§

Source§

impl Drop for ObjectReader

What: impl Drop runs when the value goes out of scope, like a finally block attached to the value itself. Why: A child that is never waited for stays in the process table as a zombie, which counts against the process limit of long sessions and containers.

In TS you’d write (pseudocode):

[Symbol.dispose]() { this.#pipes = undefined; this.#child.kill(); }
Source§

fn drop(&mut self)

Close both pipes, which ends the process, then collect it.

Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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