Struct nip_core::index::NIPIndex

pub struct NIPIndex {
    pub refs: BTreeMap<String, String>,
    pub objects: BTreeMap<String, String>,
    pub prev_idx_hash: Option<String>,
}

The entrypoint data structure for every nip repo.

Every top-level nip IPFS link points at a NIPIndex. nip indices store information about all git objects contained within a given nip repository.

Fields

refs: BTreeMap<String, String>

All refs this repository knows; a {name -> sha1} mapping

objects: BTreeMap<String, String>

All objects this repository contains; a {sha1 -> IPFS hash} map

prev_idx_hash: Option<String>

The IPFS hash of the previous index

Methods

impl NIPIndex

pub fn from_nip_remote(
    remote: &NIPRemote,
    ipfs: &mut IpfsClient
) -> Result<Self, Error>

Download from IPFS and instantiate a NIPIndex

pub fn from_slice(bytes: &[u8]) -> Result<Self, Error>

Take raw index bytes and build a NIPIndex from it

pub fn push_ref_from_str(
    &mut self,
    ref_src: &str,
    ref_dst: &str,
    force: bool,
    repo: &mut Repository,
    ipfs: &mut IpfsClient
) -> Result<(), Error>

Figure out what git hash ref_src points to in repo and add it to the index as ref_dst. If ref_src is an empty string, ref_dst is deleted from the index (only the ref, the objects aren't touched).

pub fn enumerate_for_push(
    &self,
    obj: &Object,
    push_todo: &mut HashSet<Oid>,
    submodules: &mut HashSet<Oid>,
    repo: &Repository
) -> Result<(), Error>

Iteratively fill two hash sets: obj's children present in repo but missing from self (push_todo), and obj's children recognized as submodule tips. (submodules).

pub fn push_git_objects(
    &mut self,
    oids: &HashSet<Oid>,
    repo: &Repository,
    ipfs: &mut IpfsClient
) -> Result<(), Error>

Take oids and upload underlying repo git objects to IPFS. for submodules the SUBMODULE_TIP_MARKER is inserted.

pub fn fetch_to_ref_from_str(
    &self,
    git_hash: &str,
    ref_name: &str,
    repo: &mut Repository,
    ipfs: &mut IpfsClient
) -> Result<(), Error>

Fetch git_hash from self to repo's ref_name ref.

pub fn enumerate_for_fetch(
    &self,
    oid: Oid,
    fetch_todo: &mut HashSet<Oid>,
    repo: &Repository,
    ipfs: &mut IpfsClient
) -> Result<(), Error>

Fill a hash set with oid's children that are present in self but missing in repo.

pub fn fetch_nip_objects(
    &self,
    oids: &HashSet<Oid>,
    repo: &mut Repository,
    ipfs: &mut IpfsClient
) -> Result<(), Error>

Download git objects in oids from IPFS and instantiate them in repo.

pub fn ipfs_add(
    &mut self,
    ipfs: &mut IpfsClient,
    prev_remote: Option<&NIPRemote>
) -> Result<NIPRemote, Error>

Upload self to IPFS and return the IPFS/IPNS link. Plain/IPNS link use is determined as per prev_remote variant (IPNS is used for both NewIPNS and ExistingIPNS, None assumes IPFS); prev_remote is later put in the prev_idx_hash field just before upload.

Trait Implementations

impl PartialEq<NIPIndex> for NIPIndex

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

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

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

This method tests for !=.

impl Clone for NIPIndex

fn clone(&self) -> NIPIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for NIPIndex

impl Debug for NIPIndex

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

Formats the value using the given formatter.

impl Hash for NIPIndex

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, 

Feeds a slice of this type into the given [Hasher].

impl Serialize for NIPIndex

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for NIPIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.