Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub phc_url: UrlPwa,
    pub log: Option<LogConfig>,
    pub(crate) preparation_state: PreparationState,
    pub host_aliases: HostAliases,
    pub wd: PathBuf,
    pub phc: Option<ServerConfig<ExtraConfig>>,
    pub transcryptor: Option<ServerConfig<ExtraConfig>>,
    pub auths: Option<ServerConfig<ExtraConfig>>,
}
Expand description

Configuration for one, or several, of the PubHubs servers

Also used for the pubhubs admin cli command. In that case only phc_url needs to be set.

Fields§

§phc_url: UrlPwa

URL of the PubHubs Central server.

Any information on the other servers that can be stored at PHC is stored at PHC.

§log: Option<LogConfig>

Configure logging. Overwrites what’s passed through RUST_LOG.

§preparation_state: PreparationState§host_aliases: HostAliases

Specify abbreviations for an IP address that are only valid in this configuration file.

Any UrlPwa that contains one of the aliases as host name exactly (so no subdomain) will be modified to have as host name the associated IP address.

§wd: PathBuf

Path with respect to which relative paths are interpretted.

§phc: Option<ServerConfig<ExtraConfig>>

Configuration to run PubHubs Central

§transcryptor: Option<ServerConfig<ExtraConfig>>

Configuration to run the Transcryptor

§auths: Option<ServerConfig<ExtraConfig>>

Configuration to run the Authentication Server

Implementations§

Source§

impl Config

Source

pub fn load_from_path(path: &Path) -> Result<Option<Self>>

Loads Config from path and generates random values.

Returns None if there’s no file there.

Source

pub fn preliminary_prep(&mut self) -> Result<()>

Source

pub async fn prepare_for(&self, server: Name) -> Result<Self>

Clones this configuration and strips out everything that’s not needed to run the specified server. Also generated any random values not yet set.

Source

pub async fn prepare(&mut self) -> Result<()>

Prepares Config to be run; used by Config::prepare_for.

Source

pub fn json_updated(&self, pointer: &str, new_value: Value) -> Result<Self>

Creates a new Config from the current one by updating a specific part

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PrepareConfig<Rc<Extensions>> for Config

Source§

async fn prepare(&mut self, c: Rc<Extensions>) -> Result<()>

Source§

impl Serialize for Config

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PayloadTrait for T

Source§

type JsonType = T

Source§

fn to_payload(&self) -> Payload<&T>

Used when creating requests
Source§

fn into_payload(self) -> Payload<T>

Used when forming responses
Source§

fn from_payload(payload: Payload<T>) -> Result<T, Error>

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,