Struct MetadataFile 

pub struct MetadataFile {
    pub version: Version,
    pub edition: String,
    pub client_connection_id: Option<ConnectionId>,
}

Fields

version: Version

edition: String

client_connection_id: Option<ConnectionId>

Unused and always None in SpacetimeDB-standalone, but used by SpacetimeDB-cloud.

Implementations

impl MetadataFile

pub fn new(edition: &str) -> Self

pub fn read(path: &MetadataTomlPath) -> Result<Option<Self>>

pub fn write(&self, path: &MetadataTomlPath) -> Result<()>

pub fn check_compatibility_and_update(self, current: Self) -> Result<Self>

Check if this meta file is compatible with the default meta file of a just-started database, and if so return the metadata to write back to the file.

self is the metadata file read from a database, and current is the default metadata file that the active database version would right to a new database.

Trait Implementations

impl Debug for MetadataFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetadataFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MetadataFile

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

Formats the value using the given formatter.

impl Serialize for MetadataFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.