Struct ProxyServerConfig 

pub struct ProxyServerConfig {

    pub bucket_creds_fetcher: Option<Py<PyAny>>,
    pub cos_map: PyObject,
    pub http_port: Option<u16>,
    pub https_port: Option<u16>,
    pub validator: Option<Py<PyAny>>,
    pub threads: Option<usize>,
    pub verify: Option<bool>,
    pub hmac_keystore: PyObject,
    pub skip_signature_validation: Option<bool>,
    pub hmac_fetcher: Option<Py<PyAny>>,
    pub max_presign_url_usage_attempts: Option<usize>,
    pub server_name: String,
    pub auth_cache_capacity: Option<usize>,
    pub metrics_port: Option<u16>,
}

Configuration object for :pyfunc:object_storage_proxy.start_server.

Parameters

cos_map: A dictionary mapping bucket names to their respective COS configuration. Each entry should contain the following keys:

• host: The COS endpoint (e.g., “s3.eu-de.cloud-object-storage.appdomain.cloud”)
• port: The port number (e.g., 443)
• api_key/apikey: The API key for the bucket (optional)
• ttl/time-to-live: The time-to-live for the API key in seconds (optional)

bucket_creds_fetcher: Optional Python async callable that fetches the API key for a bucket. The callable should accept a single argument, the bucket name. It should return a string containing the API key. http_port: The HTTP port to listen on. https_port: The HTTPS port to listen on. validator: Optional Python async callable that validates the request. The callable should accept two arguments, the token and the bucket name. It should return a boolean indicating whether the request is valid. threads: Optional number of threads to use for the server. If not specified, the server will use a single thread.

Fields

bucket_creds_fetcher: Option<Py<PyAny>>

cos_map: PyObject

http_port: Option<u16>

https_port: Option<u16>

validator: Option<Py<PyAny>>

threads: Option<usize>

verify: Option<bool>

hmac_keystore: PyObject

skip_signature_validation: Option<bool>

hmac_fetcher: Option<Py<PyAny>>

max_presign_url_usage_attempts: Option<usize>

server_name: String

auth_cache_capacity: Option<usize>

Maximum number of (access_key, bucket, method) entries held in the in-process authorization cache. Once the limit is reached the least-recently-used entry is evicted automatically. Defaults to [AUTH_CACHE_DEFAULT_CAPACITY] (1024).

metrics_port: Option<u16>

Port to expose the Prometheus /metrics scrape endpoint on.

Only effective when the metrics Cargo feature is enabled. When None (the default) no metrics endpoint is started.

Implementations

impl ProxyServerConfig

pub fn new( cos_map: PyObject, hmac_keystore: Option<PyObject>, bucket_creds_fetcher: Option<PyObject>, http_port: Option<u16>, https_port: Option<u16>, validator: Option<PyObject>, threads: Option<usize>, verify: Option<bool>, skip_signature_validation: Option<bool>, hmac_fetcher: Option<PyObject>, max_presign_url_usage_attempts: Option<usize>, server_name: String, auth_cache_capacity: Option<usize>, metrics_port: Option<u16>, ) -> Self

pub(crate) fn __repr__(&self) -> PyResult<String>

Trait Implementations

impl Debug for ProxyServerConfig

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

Formats the value using the given formatter.

impl Default for ProxyServerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for ProxyServerConfig

type Target = ProxyServerConfig

The Python output type

type Output = Bound<'py, <ProxyServerConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for ProxyServerConfig

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for ProxyServerConfig

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<ProxyServerConfig>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<ProxyServerConfig> for PyClassImplCollector<ProxyServerConfig>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a ProxyServerConfig

type Holder = Option<PyRef<'py, ProxyServerConfig>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut ProxyServerConfig

type Holder = Option<PyRefMut<'py, ProxyServerConfig>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<ProxyServerConfig> for PyClassImplCollector<ProxyServerConfig>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for ProxyServerConfig

const NAME: &'static str = "ProxyServerConfig"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for ProxyServerConfig