Struct Config 

pub struct Config {
    pub host: Option<String>,
    pub port: Option<u16>,
    pub base_path: Option<String>,
    pub upstream: UpstreamConfig,
    pub auth: AuthConfig,
}

Available on crate feature bin only.

Standalone storage-proxy configuration.

Fields

host: Option<String>

Host/interface to bind. Defaults to DEFAULT_HOST (all interfaces).

port: Option<u16>

TCP port to listen on. Defaults to DEFAULT_PORT.

base_path: Option<String>

URL prefix the byte-proxy surface is mounted under. Defaults to DEFAULT_BASE_PATH.

upstream: UpstreamConfig

Upstream Unity Catalog to resolve securables and vend credentials through. Required.

auth: AuthConfig

How incoming requests are authenticated. Defaults to anonymous.

Implementations

impl Config

pub fn load(path: &str) -> Result<Self, String>

Load configuration from an optional YAML file path.

None (or a path that does not exist) yields an error, because the upstream URL is required and has no default — a config-less run must supply it via CLI flags instead (see the serve command’s --upstream-url). This is only called when a path is given.

pub fn resolved_host(&self) -> &str

Resolved bind host: the configured value, else DEFAULT_HOST.

pub fn resolved_port(&self) -> u16

Resolved listen port: the configured value, else DEFAULT_PORT.

pub fn resolved_base_path(&self) -> String

Resolved mount prefix: the configured value, else DEFAULT_BASE_PATH. Normalized to a single leading slash with no trailing slash; an empty value means “mount at root”.

pub fn health_url(&self) -> String

The /health URL a healthcheck probe should GET. A wildcard bind host maps to loopback, since that is not a connectable address for a client.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config