( )⚙ D11414 rust: Make private the `index` field of the `Revlog` struct

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D11414

rust: Make private the `index` field of the `Revlog` struct
ClosedPublic

Authored by SimonSapin on Sep 14 2021, 12:45 PM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG6c653d9d41b8: rust: Make private the `index` field of the `Revlog` struct
Summary

To replace the previous use of this field from another module, add a
node_from_rev method. This is the same method that already existed on
Changelog.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Revision Contents
Changeset List

Diff 30244

rust/hg-core/src/revlog/changelog.rs

&self, &self,
rev: Revision, rev: Revision,
) -> Result<ChangelogEntry, RevlogError> { ) -> Result<ChangelogEntry, RevlogError> {
let bytes = self.revlog.get_rev_data(rev)?; let bytes = self.revlog.get_rev_data(rev)?;
Ok(ChangelogEntry { bytes }) Ok(ChangelogEntry { bytes })
} }
pub fn node_from_rev(&self, rev: Revision) -> Option<&Node> { pub fn node_from_rev(&self, rev: Revision) -> Option<&Node> {
Some(self.revlog.index.get_entry(rev)?.hash()) self.revlog.node_from_rev(rev)
} }
} }
/// `Changelog` entry which knows how to interpret the `changelog` data bytes. /// `Changelog` entry which knows how to interpret the `changelog` data bytes.
#[derive(Debug)] #[derive(Debug)]
pub struct ChangelogEntry { pub struct ChangelogEntry {
/// The data bytes of the `changelog` entry. /// The data bytes of the `changelog` entry.
bytes: Vec<u8>, bytes: Vec<u8>,

rust/hg-core/src/revlog/revlog.rs

use super::node::{NodePrefix, NODE_BYTES_LENGTH, NULL_NODE}; use super::node::{NodePrefix, NODE_BYTES_LENGTH, NULL_NODE};
use super::nodemap; use super::nodemap;
use super::nodemap::{NodeMap, NodeMapError}; use super::nodemap::{NodeMap, NodeMapError};
use super::nodemap_docket::NodeMapDocket; use super::nodemap_docket::NodeMapDocket;
use super::patch; use super::patch;
use crate::errors::HgError; use crate::errors::HgError;
use crate::repo::Repo; use crate::repo::Repo;
use crate::revlog::Revision; use crate::revlog::Revision;
use crate::NULL_REVISION; use crate::{Node, NULL_REVISION};
#[derive(derive_more::From)] #[derive(derive_more::From)]
pub enum RevlogError { pub enum RevlogError {
InvalidRevision, InvalidRevision,
/// Working directory is not supported /// Working directory is not supported
WDirUnsupported, WDirUnsupported,
/// Found more than one entry whose ID match the requested prefix /// Found more than one entry whose ID match the requested prefix
AmbiguousPrefix, AmbiguousPrefix,
} }
} }
/// Read only implementation of revlog. /// Read only implementation of revlog.
pub struct Revlog { pub struct Revlog {
/// When index and data are not interleaved: bytes of the revlog index. /// When index and data are not interleaved: bytes of the revlog index.
/// When index and data are interleaved: bytes of the revlog index and /// When index and data are interleaved: bytes of the revlog index and
/// data. /// data.
pub(crate) index: Index, index: Index,
/// When index and data are not interleaved: bytes of the revlog data /// When index and data are not interleaved: bytes of the revlog data
data_bytes: Option<Box<dyn Deref<Target = [u8]> + Send>>, data_bytes: Option<Box<dyn Deref<Target = [u8]> + Send>>,
/// When present on disk: the persistent nodemap for this revlog /// When present on disk: the persistent nodemap for this revlog
nodemap: Option<nodemap::NodeTree>, nodemap: Option<nodemap::NodeTree>,
} }
impl Revlog { impl Revlog {
/// Open a revlog index file. /// Open a revlog index file.
self.index.len() self.index.len()
} }
/// Returns `true` if the `Revlog` has zero `entries`. /// Returns `true` if the `Revlog` has zero `entries`.
pub fn is_empty(&self) -> bool { pub fn is_empty(&self) -> bool {
self.index.is_empty() self.index.is_empty()
} }
/// Returns the node ID for the given revision number, if it exists in this revlog
pub fn node_from_rev(&self, rev: Revision) -> Option<&Node> {
Some(self.index.get_entry(rev)?.hash())
}
/// Return the full data associated to a node. /// Return the full data associated to a node.
#[timed] #[timed]
pub fn get_node_rev( pub fn get_node_rev(
&self, &self,
node: NodePrefix, node: NodePrefix,
) -> Result<Revision, RevlogError> { ) -> Result<Revision, RevlogError> {
if node.is_prefix_of(&NULL_NODE) { if node.is_prefix_of(&NULL_NODE) {
return Ok(NULL_REVISION); return Ok(NULL_REVISION);