Enum gix_object::ObjectRef

pub enum ObjectRef<'a> {
    Tree(TreeRef<'a>),
    Blob(BlobRef<'a>),
    Commit(CommitRef<'a>),
    Tag(TagRef<'a>),
}

Immutable objects are read-only structures referencing most data from a byte slice.

Immutable objects are expected to be deserialized from bytes that acts as backing store, and they cannot be mutated or serialized. Instead, one will convert them into their mutable counterparts which support mutation and serialization.

An ObjectRef is representing Trees, Blobs, Commits, or Tags.

Variants

Tree(TreeRef<'a>)

Blob(BlobRef<'a>)

Commit(CommitRef<'a>)

Tag(TagRef<'a>)

Implementations

impl<'a> ObjectRef<'a>

pub fn from_loose(data: &'a [u8]) -> Result<ObjectRef<'a>, LooseDecodeError>

Deserialize an object from a loose serialisation

pub fn from_bytes(kind: Kind, data: &'a [u8]) -> Result<ObjectRef<'a>, Error>

Deserialize an object of kind from the given data.

pub fn into_owned(self) -> Object

Convert the immutable object into a mutable version, consuming the source in the process.

Note that this is an expensive operation.

pub fn to_owned(&self) -> Object

Convert this immutable object into its mutable counterpart.

Note that this is an expensive operation.

impl<'a> ObjectRef<'a>

Convenient access to contained objects.

pub fn as_blob(&self) -> Option<&BlobRef<'a>>

Interpret this object as blob.

pub fn into_blob(self) -> Option<BlobRef<'a>>

Interpret this object as blob, chainable.

pub fn as_commit(&self) -> Option<&CommitRef<'a>>

Interpret this object as commit.

pub fn into_commit(self) -> Option<CommitRef<'a>>

Interpret this object as commit, chainable.

pub fn as_tree(&self) -> Option<&TreeRef<'a>>

Interpret this object as tree.

pub fn into_tree(self) -> Option<TreeRef<'a>>

Interpret this object as tree, chainable

pub fn as_tag(&self) -> Option<&TagRef<'a>>

Interpret this object as tag.

pub fn into_tag(self) -> Option<TagRef<'a>>

Interpret this object as tag, chainable.

pub fn kind(&self) -> Kind

Return the kind of object.

Trait Implementations

impl<'a> Clone for ObjectRef<'a>

fn clone(&self) -> ObjectRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ObjectRef<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for ObjectRef<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<BlobRef<'a>> for ObjectRef<'a>

fn from(v: BlobRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<CommitRef<'a>> for ObjectRef<'a>

fn from(v: CommitRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<ObjectRef<'a>> for Object

fn from(v: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<TagRef<'a>> for ObjectRef<'a>

fn from(v: TagRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<TreeRef<'a>> for ObjectRef<'a>

fn from(v: TreeRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for ObjectRef<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ObjectRef<'a>

fn cmp(&self, other: &ObjectRef<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for ObjectRef<'a>

fn eq(&self, other: &ObjectRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for ObjectRef<'a>

fn partial_cmp(&self, other: &ObjectRef<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for ObjectRef<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<ObjectRef<'a>> for BlobRef<'a>

type Error = ObjectRef<'a>

The type returned in the event of a conversion error.

fn try_from(value: ObjectRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<ObjectRef<'a>> for CommitRef<'a>

type Error = ObjectRef<'a>

The type returned in the event of a conversion error.

fn try_from(value: ObjectRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<ObjectRef<'a>> for TagRef<'a>

type Error = ObjectRef<'a>

The type returned in the event of a conversion error.

fn try_from(value: ObjectRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<ObjectRef<'a>> for TreeRef<'a>

type Error = ObjectRef<'a>

The type returned in the event of a conversion error.

fn try_from(value: ObjectRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> WriteTo for ObjectRef<'a>

Serialization

fn write_to(&self, out: &mut dyn Write) -> Result<()>

Write the contained object to out in the git serialization format.

fn kind(&self) -> Kind

Returns the type of this object.

fn size(&self) -> u64

Returns the size of this object’s representation (the amount of data which would be written by write_to).

fn loose_header(&self) -> SmallVec<[u8; 28]>

Returns a loose object header based on the object’s data

impl<'a> Eq for ObjectRef<'a>

impl<'a> StructuralPartialEq for ObjectRef<'a>