Struct PostMergeContext 

pub struct PostMergeContext { /* private fields */ }

Context provided to post-merge hooks.

Contains metadata about the merge process that hooks may use for decision-making or diagnostics. The context is constructed by the generated merge code and passed to PostMergeHook::post_merge.

Examples

use ortho_config::PostMergeContext;
use camino::Utf8PathBuf;

let mut ctx = PostMergeContext::new("APP_");
ctx.with_file(Utf8PathBuf::from("/etc/app/config.toml"))
   .with_cli_input();

assert_eq!(ctx.prefix(), "APP_");
assert!(ctx.has_cli_input());
assert_eq!(ctx.loaded_files().len(), 1);

Implementations

impl PostMergeContext

pub fn new(prefix: impl Into<String>) -> Self

Creates a new context with the given prefix.

Examples

use ortho_config::PostMergeContext;

let ctx = PostMergeContext::new("MY_APP_");
assert_eq!(ctx.prefix(), "MY_APP_");

pub fn with_file(&mut self, path: Utf8PathBuf) -> &mut Self

Adds a loaded file path to the context.

Examples

use ortho_config::PostMergeContext;
use camino::Utf8PathBuf;

let mut ctx = PostMergeContext::new("APP_");
ctx.with_file(Utf8PathBuf::from("/etc/app.toml"));
assert_eq!(ctx.loaded_files().len(), 1);

pub fn with_cli_input(&mut self) -> &mut Self

Marks that CLI input was present in the merge.

Examples

use ortho_config::PostMergeContext;

let mut ctx = PostMergeContext::new("APP_");
ctx.with_cli_input();
assert!(ctx.has_cli_input());

pub fn prefix(&self) -> &str

Returns the prefix used during configuration loading.

Examples

use ortho_config::PostMergeContext;

let ctx = PostMergeContext::new("MY_APP_");
assert_eq!(ctx.prefix(), "MY_APP_");

pub fn loaded_files(&self) -> &[Utf8PathBuf]

Returns the paths of configuration files that contributed to the merge.

Examples

use ortho_config::PostMergeContext;
use camino::Utf8PathBuf;

let mut ctx = PostMergeContext::new("APP_");
ctx.with_file(Utf8PathBuf::from("/etc/app.toml"))
   .with_file(Utf8PathBuf::from("~/.config/app.toml"));
assert_eq!(ctx.loaded_files().len(), 2);

pub const fn has_cli_input(&self) -> bool

Returns whether CLI arguments were present in the merge.

Examples

use ortho_config::PostMergeContext;

let ctx_without_cli = PostMergeContext::new("APP_");
assert!(!ctx_without_cli.has_cli_input());

let mut ctx_with_cli = PostMergeContext::new("APP_");
ctx_with_cli.with_cli_input();
assert!(ctx_with_cli.has_cli_input());

Trait Implementations

impl Clone for PostMergeContext

fn clone(&self) -> PostMergeContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PostMergeContext

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

Formats the value using the given formatter.

impl Default for PostMergeContext

fn default() -> PostMergeContext

Returns the “default value” for a type.