gi-ostree-1.0.19: OSTree bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.OSTree.Objects.Deployment

Description

No description available in the introspection data.

Synopsis

Exported types

newtype Deployment Source #

Memory-managed wrapper type.

Constructors

Deployment (ManagedPtr Deployment) 

Instances

Instances details
Eq Deployment Source # 
Instance details

Defined in GI.OSTree.Objects.Deployment

GObject Deployment Source # 
Instance details

Defined in GI.OSTree.Objects.Deployment

ManagedPtrNewtype Deployment Source # 
Instance details

Defined in GI.OSTree.Objects.Deployment

Methods

toManagedPtr :: Deployment -> ManagedPtr Deployment

TypedObject Deployment Source # 
Instance details

Defined in GI.OSTree.Objects.Deployment

Methods

glibType :: IO GType

HasParentTypes Deployment Source # 
Instance details

Defined in GI.OSTree.Objects.Deployment

IsGValue (Maybe Deployment) Source #

Convert Deployment to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.OSTree.Objects.Deployment

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Deployment -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Deployment)

type ParentTypes Deployment Source # 
Instance details

Defined in GI.OSTree.Objects.Deployment

type ParentTypes Deployment = '[Object]

class (GObject o, IsDescendantOf Deployment o) => IsDeployment o Source #

Type class for types which can be safely cast to Deployment, for instance with toDeployment.

Instances

Instances details
(GObject o, IsDescendantOf Deployment o) => IsDeployment o Source # 
Instance details

Defined in GI.OSTree.Objects.Deployment

toDeployment :: (MonadIO m, IsDeployment o) => o -> m Deployment Source #

Cast to Deployment, for types for which this is known to be safe. For general casts, use castTo.

Methods

clone

deploymentClone Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: Deployment

-> m Deployment

Returns: New deep copy of self

No description available in the introspection data.

equal

deploymentEqual Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a, IsDeployment b) 
=> a

ap: A deployment

-> b

bp: A deployment

-> m Bool

Returns: True if deployments have the same osname, csum, and deployserial

No description available in the introspection data.

getBootconfig

deploymentGetBootconfig Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: Deployment

-> m (Maybe BootconfigParser)

Returns: Boot configuration

No description available in the introspection data.

getBootcsum

deploymentGetBootcsum :: (HasCallStack, MonadIO m, IsDeployment a) => a -> m Text Source #

No description available in the introspection data.

getBootserial

deploymentGetBootserial :: (HasCallStack, MonadIO m, IsDeployment a) => a -> m Int32 Source #

No description available in the introspection data.

getCsum

deploymentGetCsum :: (HasCallStack, MonadIO m, IsDeployment a) => a -> m Text Source #

No description available in the introspection data.

getDeployserial

deploymentGetDeployserial :: (HasCallStack, MonadIO m, IsDeployment a) => a -> m Int32 Source #

No description available in the introspection data.

getIndex

deploymentGetIndex Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: Deployment

-> m Int32

Returns: The global index into the bootloader ordering

No description available in the introspection data.

getOrigin

deploymentGetOrigin Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: Deployment

-> m (Maybe KeyFile)

Returns: Origin

No description available in the introspection data.

getOriginRelpath

deploymentGetOriginRelpath Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: A deployment

-> m Text

Returns: Path to deployment root directory, relative to sysroot

Note this function only returns a *relative* path - if you want to access, it, you must either use fd-relative api such as openat(), or concatenate it with the full sysrootGetPath.

getOsname

deploymentGetOsname :: (HasCallStack, MonadIO m, IsDeployment a) => a -> m Text Source #

No description available in the introspection data.

getUnlocked

deploymentGetUnlocked :: (HasCallStack, MonadIO m, IsDeployment a) => a -> m DeploymentUnlockedState Source #

No description available in the introspection data.

Since: 2016.4

hash

deploymentHash Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

v: Deployment

-> m Word32

Returns: An integer suitable for use in a GHashTable

No description available in the introspection data.

isFinalizationLocked

deploymentIsFinalizationLocked Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: Deployment

-> m Bool

Returns: TRUE if deployment is queued to be "finalized" at shutdown time, but requires additional action.

No description available in the introspection data.

Since: 2023.8

isPinned

deploymentIsPinned Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: Deployment

-> m Bool

Returns: TRUE if deployment will not be subject to GC

See sysrootDeploymentSetPinned.

Since: 2018.3

isStaged

deploymentIsStaged Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: Deployment

-> m Bool

Returns: TRUE if deployment should be "finalized" at shutdown time

No description available in the introspection data.

Since: 2018.3

new

deploymentNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Int32

index: Global index into the bootloader entries

-> Text

osname: "stateroot" for this deployment

-> Text

csum: OSTree commit that will be deployed

-> Int32

deployserial: Unique counter

-> Maybe Text

bootcsum: Kernel/initrd checksum

-> Int32

bootserial: Unique index

-> m Deployment

Returns: New deployment

No description available in the introspection data.

originRemoveTransientState

deploymentOriginRemoveTransientState Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> KeyFile

origin: An origin

-> m () 

The intention of an origin file is primarily describe the "inputs" that resulted in a deployment, and it's commonly used to derive the new state. For example, a key value (in pure libostree mode) is the "refspec". However, libostree (or other applications) may want to store "transient" state that should not be carried across upgrades.

This function just removes all members of the libostree-transient group. The name of that group is available to all libostree users; best practice would be to prefix values underneath there with a short identifier for your software.

Additionally, this function will remove the origin/unlocked and origin/override-commit members; these should be considered transient state that should have been under an explicit group.

Since: 2018.3

setBootconfig

deploymentSetBootconfig Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a, IsBootconfigParser b) 
=> a

self: Deployment

-> Maybe b

bootconfig: Bootloader configuration object

-> m () 

Set or clear the bootloader configuration.

setBootserial

deploymentSetBootserial Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: Deployment

-> Int32

index: Don't use this

-> m () 

Should never have been made public API; don't use this.

setIndex

deploymentSetIndex Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: Deployment

-> Int32

index: Index into bootloader ordering

-> m () 

Sets the global index into the bootloader ordering.

setOrigin

deploymentSetOrigin Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeployment a) 
=> a

self: Deployment

-> Maybe KeyFile

origin: Set the origin for this deployment

-> m () 

Replace the "origin", which is a description of the source of the deployment and how to update to the next version.

unlockedStateToString

deploymentUnlockedStateToString Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> DeploymentUnlockedState 
-> m Text

Returns: Description of state

No description available in the introspection data.

Since: 2016.4