Skip to main content

LfsPointer

Struct LfsPointer 

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

Parsed Git LFS pointer with spec-compliant fields

Per the Git LFS specification, pointer files contain:

  • version - URL of the LFS spec
  • oid sha256: - SHA256 hash of the content
  • size - Size in bytes
  • Additional extension fields (preserved for spec compliance)

Fields are private to allow future API evolution without breaking changes.

Implementations§

Source§

impl LfsPointer

Source

pub fn new(version: String, oid: String, size: u64) -> Git2DBResult<Self>

Create a new LFS pointer with the given fields

This constructor validates the OID format.

Source

pub fn new_with_hash_method( version: String, hash_method: String, oid: String, size: u64, ) -> Git2DBResult<Self>

Create a new LFS pointer with explicit hash method

Source

pub fn parse(content: &str) -> Git2DBResult<Self>

Parse LFS pointer from text content

Supports both standard git-lfs and legacy hawser version URLs.

§Example
ⓘ
let content = r#"version https://git-lfs.github.com/spec/v1
oid sha256:abc123...
size 1024
"#;
let pointer = LfsPointer::parse(content)?;
Source

pub fn version(&self) -> &str

Get the LFS version URL

Source

pub fn hash_method(&self) -> &str

Get the hash method (e.g., “sha256”)

Source

pub fn oid(&self) -> &str

Get the object ID (SHA256 hash in hex)

Source

pub fn size(&self) -> u64

Get the file size in bytes

Source

pub fn extensions(&self) -> &HashMap<String, String>

Get extension fields (spec compliance)

Source

pub fn to_merkle_hash(&self) -> Git2DBResult<MerkleHash>

👎Deprecated since 0.1.0:

unsound: reinterprets LFS SHA-256 as a XET MerkleHash; use the xet-merkle extension via xet_merkle_hash() instead — see #386

Convert the LFS SHA-256 OID to a XET MerkleHash by hex re-interpretation.

Deprecated and unsound. A XET MerkleHash is BLAKE3 keyed with the global DATA_KEY over the content-defined chunk DAG, NOT the SHA-256 of the raw bytes. The two hash families are unrelated; this conversion only succeeds by coincidence when the upload side also (incorrectly) used the SHA-256 as a MerkleHash, which real XET never does. Feeding this into smudge_from_hash therefore cannot resolve real XET content.

New code must populate the xet-merkle extension at promote time and read it back via LfsPointer::xet_merkle_hash. The smudge path no longer calls this. Kept temporarily for back-compat callers; emits a tracing::warn! so misuse is observable in logs. See issue #386.

Source

pub fn xet_merkle_hex(&self) -> Option<&str>

Get the xet-merkle extension value (64-char hex MerkleHash), if present.

Returns None for vanilla LFS pointers that carry no XET metadata. Presence of this field indicates the pointer is self-describing for Hub-free XET smudge.

Source

pub fn xet_shard(&self) -> Option<&str>

Get the xet-shard extension value (opaque locality hint), if present.

Source

pub fn xet_merkle_hash(&self) -> Git2DBResult<MerkleHash>

Resolve the XET MerkleHash for this pointer from the xet-merkle extension.

This is the correct, Hub-free derivation: the hash is read verbatim from the pointer rather than mis-converted from the LFS SHA-256 OID. Returns a LfsErrorKind::MissingXetMerkle error if the extension is absent, so callers cannot silently fall through to the unsound legacy path.

Source

pub fn set_xet_extensions(&mut self, merkle: &MerkleHash, shard: Option<&str>)

Set the xet-merkle and (optionally) xet-shard extensions in place.

Intended for promote-time code that has just computed the real XET MerkleHash for the blob’s content-defined chunk DAG and wants to record it on the pointer so downstream smudge is Hub-free and self-describing. Overwrites any prior value for these keys; other extensions are preserved.

Trait Implementations§

Source§

impl Clone for LfsPointer

Source§

fn clone(&self) -> LfsPointer

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 LfsPointer

Source§

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

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

impl Display for LfsPointer

Source§

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

Formats the value using the given formatter. 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
§

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

§

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

§

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

§

fn type_name(&self) -> &'static str

§

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

§

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

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

impl<T> Identity for T
where T: ?Sized,

§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<E> ResultError for E
where E: Send + Debug + Sync,

§

impl<T> ResultType for T
where T: Send + Clone + Sync + Debug,

§

impl<T> TerminalState for T
where T: Clone + Send + Sync,