Struct Definition 

pub struct Definition {
    pub instance_name: InstanceName,
    pub application_name: Option<ApplicationName>,
    pub backend: Backend,
    pub database: Database,
    pub seeds: IndexMap<SeedName, Seed>,
    pub ssl_config: Option<SslConfig>,
    pub superuser: User,
    pub image: Image,
    pub cross_container_access: bool,
    pub wait_available_timeout: Duration,
    pub remove: bool,
}

Fields

instance_name: InstanceName

application_name: Option<ApplicationName>

backend: Backend

database: Database

seeds: IndexMap<SeedName, Seed>

ssl_config: Option<SslConfig>

superuser: User

image: Image

cross_container_access: bool

wait_available_timeout: Duration

remove: bool

Implementations

impl Definition

pub fn new(backend: Backend, image: Image, instance_name: InstanceName) -> Self

pub fn remove(self, remove: bool) -> Self

pub fn image(self, image: Image) -> Self

pub fn add_seed( self, name: SeedName, seed: Seed, ) -> Result<Self, DuplicateSeedName>

pub fn apply_file( self, name: SeedName, path: PathBuf, ) -> Result<Self, DuplicateSeedName>

pub async fn load_seeds( &self, instance_name: &InstanceName, ) -> Result<LoadedSeeds<'_>, LoadError>

pub async fn print_cache_status( &self, instance_name: &InstanceName, json: bool, ) -> Result<(), Error>

pub fn superuser(self, user: User) -> Self

pub fn apply_file_from_git_revision( self, name: SeedName, path: PathBuf, git_revision: impl Into<String>, ) -> Result<Self, DuplicateSeedName>

pub fn apply_command( self, name: SeedName, command: Command, cache: CommandCacheConfig, ) -> Result<Self, DuplicateSeedName>

pub fn apply_script( self, name: SeedName, script: impl Into<String>, ) -> Result<Self, DuplicateSeedName>

pub fn apply_container_script( self, name: SeedName, script: impl Into<String>, ) -> Result<Self, DuplicateSeedName>

pub fn ssl_config(self, ssl_config: SslConfig) -> Self

pub fn cross_container_access(self, enabled: bool) -> Self

pub fn wait_available_timeout(self, timeout: Duration) -> Self

pub fn to_ociman_definition(&self) -> Definition

pub async fn with_container<T>( &self, action: impl AsyncFnMut(&Container) -> T, ) -> Result<T, Error>

pub async fn populate_cache( &self, instance_name: &InstanceName, ) -> Result<(Option<Reference>, Vec<LoadedSeed>), Error>

Populate cache images for seeds.

Returns a tuple of:

• The last cache hit reference (if any), which can be used to boot from
• The loaded seeds that could not be cached because the cache chain was broken

pub async fn run_integration_server( &self, result_fd: RawFd, control_fd: RawFd, ) -> Result<(), Error>

pub async fn schema_dump( &self, client_config: &Config, pg_schema_dump: &PgSchemaDump, ) -> String

Trait Implementations

impl Clone for Definition

fn clone(&self) -> Definition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Definition

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

Formats the value using the given formatter.

impl PartialEq for Definition

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Definition