Struct SysrootLock

pub struct SysrootLock {
    pub sysroot: Sysroot,
    /* private fields */
}

A locked system root.

Fields

sysroot: Sysroot

The underlying sysroot value.

Implementations

impl SysrootLock

pub async fn new_from_sysroot(sysroot: &Sysroot) -> Result<Self>

Asynchronously acquire a sysroot lock. If the lock cannot be acquired immediately, a status message will be printed to standard output. The lock will be unlocked when this object is dropped.

pub fn from_assumed_locked(sysroot: &Sysroot) -> Self

This function should only be used when you have locked the sysroot externally (e.g. in C/C++ code). This also does not unlock on drop.

Methods from Deref<Target = Sysroot>

pub fn cleanup( &self, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn deploy_tree( &self, osname: Option<&str>, revision: &str, origin: Option<&KeyFile>, provided_merge_deployment: Option<&Deployment>, override_kernel_argv: &[&str], cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Deployment, Error>

Available on crate feature v2018_5 only.

pub fn deploy_tree_with_options( &self, osname: Option<&str>, revision: &str, origin: Option<&KeyFile>, provided_merge_deployment: Option<&Deployment>, opts: Option<&SysrootDeployTreeOpts<'_>>, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Deployment, Error>

Available on crate feature v2020_7 only.

pub fn deployment_set_kargs( &self, deployment: &Deployment, new_kargs: &[&str], cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn deployment_set_kargs_in_place( &self, deployment: &Deployment, kargs_str: Option<&str>, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn deployment_set_mutable( &self, deployment: &Deployment, is_mutable: bool, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn deployment_set_pinned( &self, deployment: &Deployment, is_pinned: bool, ) -> Result<(), Error>

Available on crate feature v2018_3 only.

pub fn deployment_unlock( &self, deployment: &Deployment, unlocked_state: DeploymentUnlockedState, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

Available on crate feature v2016_4 only.

pub fn ensure_initialized( &self, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn booted_deployment(&self) -> Option<Deployment>

pub fn bootversion(&self) -> i32

pub fn deployment_directory(&self, deployment: &Deployment) -> File

pub fn deployment_dirpath(&self, deployment: &Deployment) -> GString

pub fn deployments(&self) -> Vec<Deployment>

pub fn fd(&self) -> i32

pub fn merge_deployment(&self, osname: Option<&str>) -> Option<Deployment>

pub fn path(&self) -> File

pub fn staged_deployment(&self) -> Option<Deployment>

Available on crate feature v2018_5 only.

pub fn subbootversion(&self) -> i32

pub fn init_osname( &self, osname: &str, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

Available on crate feature v2016_4 only.

pub fn initialize(&self) -> Result<(), Error>

Available on crate feature v2020_1 only.

pub fn initialize_with_mount_namespace( &self, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

Available on crate feature v2022_7 only.

pub fn is_booted(&self) -> bool

Available on crate feature v2020_1 only.

pub fn load( &self, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn load_if_changed( &self, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<bool, Error>

Available on crate feature v2016_4 only.

pub fn lock(&self) -> Result<(), Error>

pub fn lock_async<P>( &self, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

where P: FnOnce(Result<(), Error>) + 'static,

pub fn lock_future(&self) -> Pin<Box<dyn Future<Output = Result<(), Error>>>>

pub fn origin_new_from_refspec(&self, refspec: &str) -> KeyFile

pub fn prepare_cleanup( &self, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn query_deployments_for( &self, osname: Option<&str>, ) -> (Option<Deployment>, Option<Deployment>)

Available on crate feature v2017_7 only.

pub fn repo(&self) -> Repo

Available on crate feature v2017_7 only.

pub fn require_booted_deployment(&self) -> Result<Deployment, Error>

Available on crate feature v2021_1 only.

pub fn set_mount_namespace_in_use(&self)

Available on crate feature v2020_1 only.

pub fn simple_write_deployment( &self, osname: Option<&str>, new_deployment: &Deployment, merge_deployment: Option<&Deployment>, flags: SysrootSimpleWriteDeploymentFlags, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn stage_overlay_initrd( &self, fd: i32, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<GString, Error>

Available on crate feature v2020_7 only.

pub fn stage_tree( &self, osname: Option<&str>, revision: &str, origin: Option<&KeyFile>, merge_deployment: Option<&Deployment>, override_kernel_argv: &[&str], cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Deployment, Error>

Available on crate feature v2018_5 only.

pub fn stage_tree_with_options( &self, osname: Option<&str>, revision: &str, origin: Option<&KeyFile>, merge_deployment: Option<&Deployment>, opts: &SysrootDeployTreeOpts<'_>, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Deployment, Error>

Available on crate feature v2020_7 only.

pub fn try_lock(&self) -> Result<bool, Error>

pub fn unload(&self)

pub fn unlock(&self)

pub fn write_deployments( &self, new_deployments: &[Deployment], cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn write_deployments_with_options( &self, new_deployments: &[Deployment], opts: &SysrootWriteDeploymentsOpts, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

Available on crate feature v2017_4 only.

pub fn write_origin_file( &self, deployment: &Deployment, new_origin: Option<&KeyFile>, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn connect_journal_msg<F>(&self, f: F) -> SignalHandlerId

where F: Fn(&Sysroot, &str) + Send + 'static,

Available on crate feature v2017_10 only.

Trait Implementations

impl Debug for SysrootLock

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

Formats the value using the given formatter.

impl Deref for SysrootLock

type Target = Sysroot

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for SysrootLock

fn drop(&mut self)

Executes the destructor for this type.