dbcrossbarlib 0.5.3

Library for copying data between databases (pre-release)
Documentation
//! Support for `dbcrossbar-schema` locators.

use std::{fmt, str::FromStr};

use self::external_schema::ExternalSchema;
use crate::common::*;

pub(crate) mod external_schema;

/// A JSON file containing a `dbcrossbar` native schema.
#[derive(Clone, Debug)]
pub struct DbcrossbarSchemaLocator {
    path: PathOrStdio,
}

impl fmt::Display for DbcrossbarSchemaLocator {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.path.fmt_locator_helper(Self::scheme(), f)
    }
}

impl FromStr for DbcrossbarSchemaLocator {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        let path = PathOrStdio::from_str_locator_helper(Self::scheme(), s)?;
        Ok(DbcrossbarSchemaLocator { path })
    }
}

impl Locator for DbcrossbarSchemaLocator {
    fn as_any(&self) -> &dyn Any {
        self
    }

    fn schema(&self, _ctx: Context) -> BoxFuture<Option<Schema>> {
        schema_helper(self.to_owned()).boxed()
    }

    fn write_schema(
        &self,
        _ctx: Context,
        schema: Schema,
        if_exists: IfExists,
    ) -> BoxFuture<()> {
        write_schema_helper(self.to_owned(), schema, if_exists).boxed()
    }
}

impl LocatorStatic for DbcrossbarSchemaLocator {
    fn scheme() -> &'static str {
        "dbcrossbar-schema:"
    }

    fn features() -> Features {
        Features {
            locator: LocatorFeatures::Schema | LocatorFeatures::WriteSchema,
            write_schema_if_exists: IfExistsFeatures::no_append(),
            source_args: EnumSet::empty(),
            dest_args: EnumSet::empty(),
            dest_if_exists: EnumSet::empty(),
            _placeholder: (),
        }
    }
}

/// Implementation of `schema`, but as a real `async` function.
#[instrument(level = "trace", name = "dbcrossbar_schema::schema")]
async fn schema_helper(source: DbcrossbarSchemaLocator) -> Result<Option<Schema>> {
    // Read our input.
    let input = source.path.open_async().await?;
    let data = async_read_to_end(input)
        .await
        .with_context(|| format!("error reading {}", source.path))?;

    // Parse our input as table JSON.
    let external_schema: ExternalSchema = serde_json::from_slice(&data)
        .with_context(|| format!("error parsing {}", source.path))?;
    // TODO(schema): Allow selecting one of several values from `tables` here.
    Ok(Some(external_schema.into_schema()?))
}

/// Implementation of `write_schema`, but as a real `async` function.
#[instrument(
    level = "trace",
    name = "dbcrossbar_schema::write_schema",
    skip(schema, if_exists)
)]
async fn write_schema_helper(
    dest: DbcrossbarSchemaLocator,
    schema: Schema,
    if_exists: IfExists,
) -> Result<()> {
    // Generate our JSON.
    let mut f = dest.path.create_async(if_exists).await?;
    buffer_sync_write_and_copy_to_async(&mut f, |buff| {
        serde_json::to_writer_pretty(buff, &schema)
    })
    .await
    .with_context(|| format!("error writing to {}", dest.path))?;
    f.flush().await?;
    Ok(())
}