Skip to main content

CreationSource

Struct CreationSource 

Source
pub struct CreationSource {
    pub path: PathBuf,
    pub par2_name: String,
    pub file_id: FileId,
    pub file_length: u64,
    pub hash_full: [u8; 16],
    pub hash_16k: [u8; 16],
    pub slice_checksums: Vec<SliceChecksum>,
}
Expand description

A validated explicit source file and the metadata needed by critical PAR2 packets.

§What a planned source has, and what only a created one has

Planning needs a file’s identity — path, PAR2 name, length, the 16 KiB digest, the FileId derived from them, and how many slices the file occupies. It does not need the file’s contents: hash_full and the per-slice checksums are read by exactly one place, the FileDesc and IFSC bodies in output.rs, and those are only written when outputs are.

Planning fills only the identity, leaving hash_full zero and one zeroed SliceChecksum per slice — correctly sized, so every quantity derived from a source (packet lengths, the memory plan, the staged packet layout) is already final at planning time — and creation fills the content hashes from the encoder’s input feed where possible, avoiding a separate hashing pass. Other paths read the source to compute the hashes before writing the final packets.

A source held by a Par2CreatePlan therefore carries placeholder content hashes; the sources handed to packet building never do.

Fields§

§path: PathBuf

Canonical path read during creation.

§par2_name: String

Safe path recorded in PAR2 packets, using / separators.

§file_id: FileId

PAR2 file identifier.

§file_length: u64

Source length in bytes.

§hash_full: [u8; 16]

MD5 of the complete source file. Zero until creation fills it; see the type’s note on planned versus created sources.

§hash_16k: [u8; 16]

MD5 of the first 16KiB, or the complete file when shorter.

§slice_checksums: Vec<SliceChecksum>

Zero-padded per-slice CRC32 and MD5 pairs. One entry per slice from planning onward; the entries are zero until creation fills them.

Implementations§

Source§

impl CreationSource

Source

pub fn slice_count(&self) -> u32

Number of source slices represented by this source.

Trait Implementations§

Source§

impl Clone for CreationSource

Source§

fn clone(&self) -> CreationSource

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CreationSource

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CreationSource

Source§

impl PartialEq for CreationSource

Source§

fn eq(&self, other: &CreationSource) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CreationSource

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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