common_options/plugin_options.rs
1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::sync::Arc;
16
17use serde::de::DeserializeOwned;
18
19/// A trait for serializing Metasrv config to a JSON string.
20/// So it can be used in the metasrv's crate instead of depending on the plugins' crate.
21pub trait PluginOptionsSerializer: Send + Sync {
22 fn serialize(&self) -> Result<String, serde_json::Error>;
23}
24pub type PluginOptionsSerializerRef = Arc<dyn PluginOptionsSerializer>;
25
26/// A trait for deserializing Metasrv config from a JSON string.
27pub trait PluginOptionsDeserializer<T: DeserializeOwned>: Send + Sync {
28 fn deserialize(&self, payload: &str) -> Result<T, serde_json::Error>;
29}