Trait ConfigurationFile

pub trait ConfigurationFile: Sized {
    type Contents: Serialize;

    const FILENAME: &'static str;

    // Required methods
    fn from_directory(
        monorepo_root: &Directory,
        relative_directory: Directory,
    ) -> Result<Self, FromFileError>;
    fn directory(&self) -> &Directory;
    fn path(&self) -> PathBuf;
    fn contents(&self) -> &Self::Contents;

    // Provided method
    fn write(
        monorepo_root: &Path,
        configuration_file: impl ConfigurationFile,
    ) -> Result<(), WriteError> { ... }
}

Configuration file for some component of the monorepo.

Required Associated Constants

const FILENAME: &'static str

Basename of the configuration file.

Required Associated Types

type Contents: Serialize

Required Methods

fn from_directory( monorepo_root: &Directory, relative_directory: Directory, ) -> Result<Self, FromFileError>

Create an instance of this configuration file by reading the specified file from this directory on disk.

fn directory(&self) -> &Directory

Relative path to directory containing this configuration file, from monorepo root.

fn path(&self) -> PathBuf

Relative path to this configuration file from the monorepo root.

fn contents(&self) -> &Self::Contents

Provided Methods

fn write( monorepo_root: &Path, configuration_file: impl ConfigurationFile, ) -> Result<(), WriteError>

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl ConfigurationFile for PackageManifest

const FILENAME: &'static str = "package.json"

type Contents = PackageManifestFile

impl ConfigurationFile for TypescriptConfig

const FILENAME: &'static str = "tsconfig.json"

type Contents = Map<String, Value>

impl ConfigurationFile for TypescriptParentProjectReference

const FILENAME: &'static str = "tsconfig.json"

type Contents = TypescriptParentProjectReferenceFile