pub struct GenericWorkingTree(pub Py<PyAny>);Expand description
A working tree in a version control system.
A working tree is a local directory containing the files of a branch that can be edited. This struct wraps a Python working tree object and provides access to its functionality.
Tuple Fields§
§0: Py<PyAny>Implementations§
Source§impl GenericWorkingTree
impl GenericWorkingTree
Sourcepub fn open_containing(
path: &Path,
) -> Result<(GenericWorkingTree, PathBuf), Error>
👎Deprecated: Use ::open_containing instead
pub fn open_containing( path: &Path, ) -> Result<(GenericWorkingTree, PathBuf), Error>
Use ::open_containing instead
Open a working tree containing the specified path.
This method is deprecated, use the module-level open_containing function instead.
§Parameters
path- The path to look for a containing working tree.
§Returns
A tuple containing the working tree and the relative path, or an error if no containing working tree could be found.
Sourcepub fn commit(
&self,
message: &str,
committer: Option<&str>,
timestamp: Option<f64>,
allow_pointless: Option<bool>,
specific_files: Option<&[&Path]>,
) -> Result<RevisionId, Error>
👎Deprecated: Use build_commit instead
pub fn commit( &self, message: &str, committer: Option<&str>, timestamp: Option<f64>, allow_pointless: Option<bool>, specific_files: Option<&[&Path]>, ) -> Result<RevisionId, Error>
Use build_commit instead
Create a commit with the specified parameters.
This method is deprecated, use the build_commit method instead.
§Parameters
message- The commit message.allow_pointless- Whether to allow commits that don’t change any files.committer- The committer’s name and email.specific_files- The paths of files to include in this commit.
§Returns
The revision ID of the new commit, or an error if the commit could not be created.
Trait Implementations§
Source§impl Clone for GenericWorkingTree
impl Clone for GenericWorkingTree
Source§impl From<GenericWorkingTree> for CommitBuilder
impl From<GenericWorkingTree> for CommitBuilder
Source§impl From<Py<PyAny>> for GenericWorkingTree
Implementation of From<Py> for GenericWorkingTree.
impl From<Py<PyAny>> for GenericWorkingTree
Implementation of From<Py
Source§impl<'py> IntoPyObject<'py> for GenericWorkingTree
impl<'py> IntoPyObject<'py> for GenericWorkingTree
Source§type Output = Bound<'py, <GenericWorkingTree as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <GenericWorkingTree as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§type Error = Infallible
type Error = Infallible
The type returned in the event of a conversion error.
Source§impl PyTree for GenericWorkingTree
impl PyTree for GenericWorkingTree
impl PyMutableTree for GenericWorkingTree
impl PyWorkingTree for GenericWorkingTree
Auto Trait Implementations§
impl Freeze for GenericWorkingTree
impl !RefUnwindSafe for GenericWorkingTree
impl Send for GenericWorkingTree
impl Sync for GenericWorkingTree
impl Unpin for GenericWorkingTree
impl UnsafeUnpin for GenericWorkingTree
impl UnwindSafe for GenericWorkingTree
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information.Source§impl<T> MutableTree for Twhere
T: PyMutableTree + ?Sized,
impl<T> MutableTree for Twhere
T: PyMutableTree + ?Sized,
Source§fn put_file_bytes_non_atomic(
&self,
path: &Path,
data: &[u8],
) -> Result<(), Error>
fn put_file_bytes_non_atomic( &self, path: &Path, data: &[u8], ) -> Result<(), Error>
Write bytes to a file in the tree without atomic guarantees.
Source§fn remove(&self, files: &[&Path]) -> Result<(), Error>
fn remove(&self, files: &[&Path]) -> Result<(), Error>
Remove specified files from version control and from the filesystem.
Source§fn add_reference(&self, reference: &TreeReference) -> Result<(), Error>
fn add_reference(&self, reference: &TreeReference) -> Result<(), Error>
Add a tree reference.
Source§fn copy_one(&self, from_path: &Path, to_path: &Path) -> Result<(), Error>
fn copy_one(&self, from_path: &Path, to_path: &Path) -> Result<(), Error>
Copy a file or directory to a new location.
Source§fn last_revision(&self) -> Result<RevisionId, Error>
fn last_revision(&self) -> Result<RevisionId, Error>
Get the last revision ID.
Source§fn set_parent_ids(&self, parent_ids: &[RevisionId]) -> Result<(), Error>
fn set_parent_ids(&self, parent_ids: &[RevisionId]) -> Result<(), Error>
Set the parent IDs for this tree.
Source§fn set_parent_trees(
&self,
parent_trees: &[(RevisionId, RevisionTree)],
) -> Result<(), Error>
fn set_parent_trees( &self, parent_trees: &[(RevisionId, RevisionTree)], ) -> Result<(), Error>
Set the parent trees for this tree.
Source§fn apply_inventory_delta(&self, delta: Vec<InventoryDelta>) -> Result<(), Error>
fn apply_inventory_delta(&self, delta: Vec<InventoryDelta>) -> Result<(), Error>
Apply a delta to the tree.
Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> Tree for T
impl<T> Tree for T
Source§fn get_tag_dict(&self) -> Result<HashMap<String, RevisionId>, Error>
fn get_tag_dict(&self) -> Result<HashMap<String, RevisionId>, Error>
Get a dictionary of tags and their revision IDs.
Source§fn get_file(&self, path: &Path) -> Result<Box<dyn Read>, Error>
fn get_file(&self, path: &Path) -> Result<Box<dyn Read>, Error>
Get a file from the tree as a readable stream.
Source§fn get_file_text(&self, path: &Path) -> Result<Vec<u8>, Error>
fn get_file_text(&self, path: &Path) -> Result<Vec<u8>, Error>
Get the contents of a file from the tree as a byte vector.
Source§fn get_file_lines(&self, path: &Path) -> Result<Vec<Vec<u8>>, Error>
fn get_file_lines(&self, path: &Path) -> Result<Vec<Vec<u8>>, Error>
Get the contents of a file as a vector of lines (byte vectors).
Source§fn has_filename(&self, path: &Path) -> bool
fn has_filename(&self, path: &Path) -> bool
Check if a file exists in the tree at the specified path.
Source§fn get_symlink_target(&self, path: &Path) -> Result<PathBuf, Error>
fn get_symlink_target(&self, path: &Path) -> Result<PathBuf, Error>
Get the target of a symbolic link.
Source§fn get_parent_ids(&self) -> Result<Vec<RevisionId>, Error>
fn get_parent_ids(&self) -> Result<Vec<RevisionId>, Error>
Get the IDs of the parent revisions of this tree.
Source§fn is_ignored(&self, path: &Path) -> Option<String>
fn is_ignored(&self, path: &Path) -> Option<String>
Check if a path is ignored by version control.
Source§fn kind(&self, path: &Path) -> Result<Kind, Error>
fn kind(&self, path: &Path) -> Result<Kind, Error>
Get the kind of object at the specified path (file, directory, symlink, etc.).
Source§fn is_versioned(&self, path: &Path) -> bool
fn is_versioned(&self, path: &Path) -> bool
Check if a path is under version control.
Source§fn iter_changes(
&self,
other: &(dyn PyTree + 'static),
specific_files: Option<&[&Path]>,
want_unversioned: Option<bool>,
require_versioned: Option<bool>,
) -> Result<Box<dyn Iterator<Item = Result<TreeChange, Error>>>, Error>
fn iter_changes( &self, other: &(dyn PyTree + 'static), specific_files: Option<&[&Path]>, want_unversioned: Option<bool>, require_versioned: Option<bool>, ) -> Result<Box<dyn Iterator<Item = Result<TreeChange, Error>>>, Error>
Iterate through the changes between this tree and another tree. Read more
Source§fn has_versioned_directories(&self) -> bool
fn has_versioned_directories(&self) -> bool
Check if this tree supports versioned directories.
Source§fn preview_transform(&self) -> Result<TreeTransform, Error>
fn preview_transform(&self) -> Result<TreeTransform, Error>
Get a preview of transformations that would be applied to this tree.
Source§fn list_files(
&self,
include_root: Option<bool>,
from_dir: Option<&Path>,
recursive: Option<bool>,
recurse_nested: Option<bool>,
) -> Result<Box<dyn Iterator<Item = Result<(PathBuf, bool, Kind, TreeEntry), Error>>>, Error>
fn list_files( &self, include_root: Option<bool>, from_dir: Option<&Path>, recursive: Option<bool>, recurse_nested: Option<bool>, ) -> Result<Box<dyn Iterator<Item = Result<(PathBuf, bool, Kind, TreeEntry), Error>>>, Error>
List files in the tree, optionally recursively. Read more
Source§fn iter_child_entries(
&self,
path: &Path,
) -> Result<Box<dyn Iterator<Item = Result<(PathBuf, Kind, TreeEntry), Error>>>, Error>
fn iter_child_entries( &self, path: &Path, ) -> Result<Box<dyn Iterator<Item = Result<(PathBuf, Kind, TreeEntry), Error>>>, Error>
Iterate through entries in a directory. Read more
Source§fn get_file_sha1(
&self,
path: &Path,
_stat_value: Option<&Metadata>,
) -> Result<String, Error>
fn get_file_sha1( &self, path: &Path, _stat_value: Option<&Metadata>, ) -> Result<String, Error>
Get the SHA1 hash of a file’s contents.
Source§fn get_file_mtime(&self, path: &Path) -> Result<u64, Error>
fn get_file_mtime(&self, path: &Path) -> Result<u64, Error>
Get the modification time of a file.
Source§fn stored_kind(&self, path: &Path) -> Result<Kind, Error>
fn stored_kind(&self, path: &Path) -> Result<Kind, Error>
Get the stored kind of a file (as opposed to the actual kind on disk).
Source§fn supports_content_filtering(&self) -> bool
fn supports_content_filtering(&self) -> bool
Check if the tree supports content filtering.
Source§fn supports_file_ids(&self) -> bool
fn supports_file_ids(&self) -> bool
Check if the tree supports file IDs.
Source§fn supports_rename_tracking(&self) -> bool
fn supports_rename_tracking(&self) -> bool
Check if the tree supports rename tracking.
Source§fn supports_symlinks(&self) -> bool
fn supports_symlinks(&self) -> bool
Check if the tree supports symbolic links.
Source§fn supports_tree_reference(&self) -> bool
fn supports_tree_reference(&self) -> bool
Check if the tree supports tree references.
Source§fn all_versioned_paths(
&self,
) -> Result<Box<dyn Iterator<Item = Result<PathBuf, Error>>>, Error>
fn all_versioned_paths( &self, ) -> Result<Box<dyn Iterator<Item = Result<PathBuf, Error>>>, Error>
Get all versioned paths in the tree.
Source§fn filter_unversioned_files(
&self,
paths: &[&Path],
) -> Result<Vec<PathBuf>, Error>
fn filter_unversioned_files( &self, paths: &[&Path], ) -> Result<Vec<PathBuf>, Error>
Filter out versioned files from a list of paths.
Source§fn walkdirs(
&self,
prefix: Option<&Path>,
) -> Result<Box<dyn Iterator<Item = Result<WalkdirResult, Error>>>, Error>
fn walkdirs( &self, prefix: Option<&Path>, ) -> Result<Box<dyn Iterator<Item = Result<WalkdirResult, Error>>>, Error>
Walk directories in the tree.
Source§fn versionable_kind(&self, kind: &Kind) -> bool
fn versionable_kind(&self, kind: &Kind) -> bool
Check if a file kind is versionable.
Source§fn path_content_summary(&self, path: &Path) -> Result<PathContentSummary, Error>
fn path_content_summary(&self, path: &Path) -> Result<PathContentSummary, Error>
Get file content summary for a path.
Source§fn iter_files_bytes(
&self,
paths: &[&Path],
) -> Result<Box<dyn Iterator<Item = Result<(PathBuf, Vec<u8>), Error>>>, Error>
fn iter_files_bytes( &self, paths: &[&Path], ) -> Result<Box<dyn Iterator<Item = Result<(PathBuf, Vec<u8>), Error>>>, Error>
Iterate through file bytes.
Source§fn iter_entries_by_dir(
&self,
specific_files: Option<&[&Path]>,
) -> Result<Box<dyn Iterator<Item = Result<(PathBuf, TreeEntry), Error>>>, Error>
fn iter_entries_by_dir( &self, specific_files: Option<&[&Path]>, ) -> Result<Box<dyn Iterator<Item = Result<(PathBuf, TreeEntry), Error>>>, Error>
Iterate through entries by directory.
Source§fn get_file_verifier(
&self,
path: &Path,
_stat_value: Option<&Metadata>,
) -> Result<(String, Vec<u8>), Error>
fn get_file_verifier( &self, path: &Path, _stat_value: Option<&Metadata>, ) -> Result<(String, Vec<u8>), Error>
Get file verifier information.
Source§fn get_reference_revision(&self, path: &Path) -> Result<RevisionId, Error>
fn get_reference_revision(&self, path: &Path) -> Result<RevisionId, Error>
Get the reference revision for a tree reference.
Source§fn archive(
&self,
format: &str,
name: &str,
root: Option<&str>,
subdir: Option<&Path>,
force_mtime: Option<f64>,
recurse_nested: bool,
) -> Result<Box<dyn Iterator<Item = Result<Vec<u8>, Error>>>, Error>
fn archive( &self, format: &str, name: &str, root: Option<&str>, subdir: Option<&Path>, force_mtime: Option<f64>, recurse_nested: bool, ) -> Result<Box<dyn Iterator<Item = Result<Vec<u8>, Error>>>, Error>
Create an archive of the tree.
Source§fn annotate_iter(
&self,
path: &Path,
default_revision: Option<&RevisionId>,
) -> Result<Box<dyn Iterator<Item = Result<(RevisionId, Vec<u8>), Error>>>, Error>
fn annotate_iter( &self, path: &Path, default_revision: Option<&RevisionId>, ) -> Result<Box<dyn Iterator<Item = Result<(RevisionId, Vec<u8>), Error>>>, Error>
Annotate a file with revision information.
Source§fn is_special_path(&self, path: &Path) -> bool
fn is_special_path(&self, path: &Path) -> bool
Check if a path is a special path (e.g., control directory).
Source§impl<T> WorkingTree for Twhere
T: PyWorkingTree + ?Sized,
impl<T> WorkingTree for Twhere
T: PyWorkingTree + ?Sized,
Source§fn revision_tree(
&self,
revision_id: &RevisionId,
) -> Result<Box<RevisionTree>, Error>
fn revision_tree( &self, revision_id: &RevisionId, ) -> Result<Box<RevisionTree>, Error>
Get a revision tree for a specific revision.
Source§fn abspath(&self, path: &Path) -> Result<PathBuf, Error>
fn abspath(&self, path: &Path) -> Result<PathBuf, Error>
Convert a path to an absolute path relative to the working tree.
Source§fn relpath(&self, path: &Path) -> Result<PathBuf, Error>
fn relpath(&self, path: &Path) -> Result<PathBuf, Error>
Convert an absolute path to a path relative to the working tree.
Source§fn pull(
&self,
source: &dyn Branch,
overwrite: Option<bool>,
stop_revision: Option<&RevisionId>,
local: Option<bool>,
) -> Result<(), Error>
fn pull( &self, source: &dyn Branch, overwrite: Option<bool>, stop_revision: Option<&RevisionId>, local: Option<bool>, ) -> Result<(), Error>
Pull changes from another branch into this working tree.
Source§fn merge_from_branch(
&self,
source: &dyn Branch,
to_revision: Option<&RevisionId>,
) -> Result<(), Error>
fn merge_from_branch( &self, source: &dyn Branch, to_revision: Option<&RevisionId>, ) -> Result<(), Error>
Merge changes from another branch into this working tree.
Source§fn safe_relpath_files(
&self,
file_list: &[&Path],
canonicalize: bool,
apply_view: bool,
) -> Result<Vec<PathBuf>, Error>
fn safe_relpath_files( &self, file_list: &[&Path], canonicalize: bool, apply_view: bool, ) -> Result<Vec<PathBuf>, Error>
Convert a list of files to relative paths safely.
Source§fn controldir(
&self,
) -> Box<dyn ControlDir<Repository = GenericRepository, WorkingTree = GenericWorkingTree, Branch = GenericBranch>>
fn controldir( &self, ) -> Box<dyn ControlDir<Repository = GenericRepository, WorkingTree = GenericWorkingTree, Branch = GenericBranch>>
Get the control directory for this working tree. Read more
Source§fn branch(&self) -> GenericBranch
fn branch(&self) -> GenericBranch
Get the branch associated with this working tree. Read more
Source§fn get_user_url(&self) -> Url
fn get_user_url(&self) -> Url
Get the user-visible URL for this working tree. Read more
Source§fn supports_setting_file_ids(&self) -> bool
fn supports_setting_file_ids(&self) -> bool
Check if this working tree supports setting the last revision. Read more
Source§fn smart_add(&self, files: &[&Path]) -> Result<(), Error>
fn smart_add(&self, files: &[&Path]) -> Result<(), Error>
Add specified files to version control and the working tree. Read more
Source§fn update(&self, revision_id: Option<&RevisionId>) -> Result<(), Error>
fn update(&self, revision_id: Option<&RevisionId>) -> Result<(), Error>
Update the working tree to a specific revision. Read more
Source§fn revert(&self, filenames: Option<&[&Path]>) -> Result<(), Error>
fn revert(&self, filenames: Option<&[&Path]>) -> Result<(), Error>
Revert changes in the working tree. Read more
Source§fn build_commit(&self) -> CommitBuilder
fn build_commit(&self) -> CommitBuilder
Create a commit builder for this working tree. Read more
Source§fn basis_tree(&self) -> Result<RevisionTree, Error>
fn basis_tree(&self) -> Result<RevisionTree, Error>
Get the basis tree for this working tree. Read more
Source§fn is_control_filename(&self, path: &Path) -> bool
fn is_control_filename(&self, path: &Path) -> bool
Check if a path is a control filename in this working tree. Read more
Source§fn add_conflicts(&self, conflicts: &[Conflict]) -> Result<(), Error>
fn add_conflicts(&self, conflicts: &[Conflict]) -> Result<(), Error>
Add conflicts to the working tree.
Source§fn add_parent_tree(
&self,
parent_id: &RevisionId,
parent_tree: &RevisionTree,
) -> Result<(), Error>
fn add_parent_tree( &self, parent_id: &RevisionId, parent_tree: &RevisionTree, ) -> Result<(), Error>
Add a parent tree.
Source§fn add_parent_tree_id(&self, parent_id: &RevisionId) -> Result<(), Error>
fn add_parent_tree_id(&self, parent_id: &RevisionId) -> Result<(), Error>
Add a parent tree ID.
Source§fn add_pending_merge(&self, revision_id: &RevisionId) -> Result<(), Error>
fn add_pending_merge(&self, revision_id: &RevisionId) -> Result<(), Error>
Add a pending merge.
Source§fn get_canonical_path(&self, path: &Path) -> Result<PathBuf, Error>
fn get_canonical_path(&self, path: &Path) -> Result<PathBuf, Error>
Get the canonical path for a file.
Source§fn get_canonical_paths(&self, paths: &[&Path]) -> Result<Vec<PathBuf>, Error>
fn get_canonical_paths(&self, paths: &[&Path]) -> Result<Vec<PathBuf>, Error>
Get canonical paths for multiple files.
Source§fn get_reference_info(
&self,
path: &Path,
) -> Result<Option<(String, PathBuf)>, Error>
fn get_reference_info( &self, path: &Path, ) -> Result<Option<(String, PathBuf)>, Error>
Get reference information.
Source§fn move_files(&self, from_paths: &[&Path], to_dir: &Path) -> Result<(), Error>
fn move_files(&self, from_paths: &[&Path], to_dir: &Path) -> Result<(), Error>
Move files within the working tree.
Source§fn set_conflicts(&self, conflicts: &[Conflict]) -> Result<(), Error>
fn set_conflicts(&self, conflicts: &[Conflict]) -> Result<(), Error>
Set conflicts in the working tree.
Source§fn set_last_revision(&self, revision_id: &RevisionId) -> Result<(), Error>
fn set_last_revision(&self, revision_id: &RevisionId) -> Result<(), Error>
Set the last revision.
Source§fn set_pending_merges(&self, revision_ids: &[RevisionId]) -> Result<(), Error>
fn set_pending_merges(&self, revision_ids: &[RevisionId]) -> Result<(), Error>
Set pending merges.
Source§fn set_reference_info(
&self,
path: &Path,
location: &str,
file_id: Option<&str>,
) -> Result<(), Error>
fn set_reference_info( &self, path: &Path, location: &str, file_id: Option<&str>, ) -> Result<(), Error>
Set reference information.
Source§fn subsume(&self, other: &(dyn PyWorkingTree + 'static)) -> Result<(), Error>
fn subsume(&self, other: &(dyn PyWorkingTree + 'static)) -> Result<(), Error>
Subsume a tree into this working tree.
Source§fn extract(&self, dest: &Path, format: Option<&str>) -> Result<(), Error>
fn extract(&self, dest: &Path, format: Option<&str>) -> Result<(), Error>
Extract the working tree to a directory.
Source§fn clone(
&self,
dest: &Path,
revision_id: Option<&RevisionId>,
) -> Result<GenericWorkingTree, Error>
fn clone( &self, dest: &Path, revision_id: Option<&RevisionId>, ) -> Result<GenericWorkingTree, Error>
Clone the working tree.
Source§fn control_url(&self) -> Url
fn control_url(&self) -> Url
Get the control URL.
Source§fn copy_content_into(
&self,
source: &(dyn PyTree + 'static),
revision_id: Option<&RevisionId>,
) -> Result<(), Error>
fn copy_content_into( &self, source: &(dyn PyTree + 'static), revision_id: Option<&RevisionId>, ) -> Result<(), Error>
Copy content into this working tree.
Source§fn requires_rich_root(&self) -> bool
fn requires_rich_root(&self) -> bool
Check if the working tree requires a rich root.
Source§fn reset_state(&self, revision_ids: Option<&[RevisionId]>) -> Result<(), Error>
fn reset_state(&self, revision_ids: Option<&[RevisionId]>) -> Result<(), Error>
Reset the state of the working tree.
Source§fn reference_parent(
&self,
path: &Path,
branch: &dyn Branch,
revision_id: Option<&RevisionId>,
) -> Result<(), Error>
fn reference_parent( &self, path: &Path, branch: &dyn Branch, revision_id: Option<&RevisionId>, ) -> Result<(), Error>
Reference a parent tree.
Source§fn supports_merge_modified(&self) -> bool
fn supports_merge_modified(&self) -> bool
Check if the working tree supports merge-modified tracking.