Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: config: Type safe API prototype #126

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions cosmic-config/examples/app.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
use cosmic_config::setting::{App, Setting, AppConfig};

struct ExampleApp;

impl App for ExampleApp {
const ID: &'static str = "com.Example.App";
const VERSION: u64 = 1;
}

struct DoFoo;

impl Setting<ExampleApp> for DoFoo {
const NAME: &'static str = "do-foo";
type Type = bool;
}

struct WhatBar;

impl Setting<ExampleApp> for WhatBar {
const NAME: &'static str = "what-bar";
type Type = String;
}

fn main() {
let config = AppConfig::<ExampleApp>::new().unwrap();
config.set::<DoFoo>(true).unwrap();
}
2 changes: 2 additions & 0 deletions cosmic-config/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ pub use cosmic_config_derive;
#[cfg(feature = "calloop")]
pub mod calloop;

pub mod setting;

#[derive(Debug)]
pub enum Error {
AtomicWrites(atomicwrites::Error<std::io::Error>),
Expand Down
36 changes: 36 additions & 0 deletions cosmic-config/src/setting.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
use crate::{Config, ConfigGet, ConfigSet, Error};

pub trait App {
const ID: &'static str;
// XXX how to handle versioning?
const VERSION: u64;
}

pub trait Setting<A: App> {
const NAME: &'static str;
// TODO can't use &str to set? Need to serialize owned value.
type Type: serde::Serialize + serde::de::DeserializeOwned;
}

pub struct AppConfig<A: App> {
config: Config,
_app: std::marker::PhantomData<A>,
}

impl<A: App> AppConfig<A> {
pub fn new() -> Result<Self, Error> {
Ok(Self {
config: Config::new(A::ID, A::VERSION)?,
_app: std::marker::PhantomData,
})
}

// XXX default value, if none set?
pub fn get<S: Setting<A>>(&self) -> Result<S::Type, Error> {
self.config.get(S::NAME)
}

pub fn set<S: Setting<A>>(&self, value: S::Type) -> Result<(), Error> {
self.config.set(S::NAME, value)
}
}