// Copyright 2020-2021, The Tremor Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Structs here are currently for use in tremor-language-server (where they are
// dependencies for the build script as well as the package -- hence they are
// bundled here for common use). These can be eventually deprecated, once all
// the functionality here is migrated to the ast doc structs (introduced in
// v0.8).
use std::fmt;
/// Function signature
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct FunctionSignatureDoc {
/// name of the function
pub full_name: String,
/// arguments to the function
pub args: Vec<String>,
/// result of the function
pub result: String,
}
// #[cfg_attr(coverage, no_coverage)]
impl fmt::Display for FunctionSignatureDoc {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let r = write!(f, "{}({})", self.full_name, self.args.join(", "));
if !self.result.is_empty() {
write!(f, " -> {}", self.result)?;
}
r
}
}
/// Function documentation
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct FunctionDoc {
/// signature
pub signature: FunctionSignatureDoc,
/// short description
pub summary: Option<String>,
/// full description for the function
pub description: String,
/// Example of usage
pub examples: Option<String>,
}
// #[cfg_attr(coverage, no_coverage)]
impl fmt::Display for FunctionDoc {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}\n\n{}", self.signature, self.description)
}
}