use crate::compiler::prelude::*;
fn to_syslog_facility(value: Value) -> Resolved {
let value = value.try_integer()?;
let code = match value {
0 => "kern",
1 => "user",
2 => "mail",
3 => "daemon",
4 => "auth",
5 => "syslog",
6 => "lpr",
7 => "news",
8 => "uucp",
9 => "cron",
10 => "authpriv",
11 => "ftp",
12 => "ntp",
13 => "security",
14 => "console",
15 => "solaris-cron",
16 => "local0",
17 => "local1",
18 => "local2",
19 => "local3",
20 => "local4",
21 => "local5",
22 => "local6",
23 => "local7",
_ => return Err(format!("facility code {value} not valid").into()),
};
Ok(code.into())
}
#[derive(Clone, Copy, Debug)]
pub struct ToSyslogFacility;
impl Function for ToSyslogFacility {
fn identifier(&self) -> &'static str {
"to_syslog_facility"
}
fn usage(&self) -> &'static str {
r#"Converts the `value`, a Syslog [facility code](https://en.wikipedia.org/wiki/Syslog#Facility), into its corresponding Syslog keyword. For example, `0` into `"kern"`, `1` into `"user"`, etc."#
}
fn category(&self) -> &'static str {
Category::Convert.as_ref()
}
fn internal_failure_reasons(&self) -> &'static [&'static str] {
&[
"`value` is not a valid Syslog [facility code](https://en.wikipedia.org/wiki/Syslog#Facility).",
]
}
fn return_kind(&self) -> u16 {
kind::BYTES
}
fn parameters(&self) -> &'static [Parameter] {
const PARAMETERS: &[Parameter] = &[Parameter::required(
"value",
kind::INTEGER,
"The facility code.",
)];
PARAMETERS
}
fn examples(&self) -> &'static [Example] {
&[
example! {
title: "Coerce to a Syslog facility",
source: "to_syslog_facility!(4)",
result: Ok("auth"),
},
example! {
title: "invalid",
source: "to_syslog_facility!(500)",
result: Err(
r#"function call error for "to_syslog_facility" at (0:24): facility code 500 not valid"#,
),
},
]
}
fn compile(
&self,
_state: &state::TypeState,
_ctx: &mut FunctionCompileContext,
arguments: ArgumentList,
) -> Compiled {
let value = arguments.required("value");
Ok(ToSyslogFacilityFn { value }.as_expr())
}
}
#[derive(Debug, Clone)]
struct ToSyslogFacilityFn {
value: Box<dyn Expression>,
}
impl FunctionExpression for ToSyslogFacilityFn {
fn resolve(&self, ctx: &mut Context) -> Resolved {
let value = self.value.resolve(ctx)?;
to_syslog_facility(value)
}
fn type_def(&self, _: &state::TypeState) -> TypeDef {
TypeDef::bytes().fallible()
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::value;
test_function![
to_syslog_facility => ToSyslogFacility;
kern {
args: func_args![value: value!(0)],
want: Ok(value!("kern")),
tdef: TypeDef::bytes().fallible(),
}
user {
args: func_args![value: value!(1)],
want: Ok(value!("user")),
tdef: TypeDef::bytes().fallible(),
}
mail {
args: func_args![value: value!(2)],
want: Ok(value!("mail")),
tdef: TypeDef::bytes().fallible(),
}
daemon {
args: func_args![value: value!(3)],
want: Ok(value!("daemon")),
tdef: TypeDef::bytes().fallible(),
}
auth {
args: func_args![value: value!(4)],
want: Ok(value!("auth")),
tdef: TypeDef::bytes().fallible(),
}
syslog {
args: func_args![value: value!(5)],
want: Ok(value!("syslog")),
tdef: TypeDef::bytes().fallible(),
}
lpr {
args: func_args![value: value!(6)],
want: Ok(value!("lpr")),
tdef: TypeDef::bytes().fallible(),
}
news {
args: func_args![value: value!(7)],
want: Ok(value!("news")),
tdef: TypeDef::bytes().fallible(),
}
uucp {
args: func_args![value: value!(8)],
want: Ok(value!("uucp")),
tdef: TypeDef::bytes().fallible(),
}
cron {
args: func_args![value: value!(9)],
want: Ok(value!("cron")),
tdef: TypeDef::bytes().fallible(),
}
authpriv {
args: func_args![value: value!(10)],
want: Ok(value!("authpriv")),
tdef: TypeDef::bytes().fallible(),
}
ftp {
args: func_args![value: value!(11)],
want: Ok(value!("ftp")),
tdef: TypeDef::bytes().fallible(),
}
ntp {
args: func_args![value: value!(12)],
want: Ok(value!("ntp")),
tdef: TypeDef::bytes().fallible(),
}
security {
args: func_args![value: value!(13)],
want: Ok(value!("security")),
tdef: TypeDef::bytes().fallible(),
}
console {
args: func_args![value: value!(14)],
want: Ok(value!("console")),
tdef: TypeDef::bytes().fallible(),
}
solaris_cron {
args: func_args![value: value!(15)],
want: Ok(value!("solaris-cron")),
tdef: TypeDef::bytes().fallible(),
}
local0 {
args: func_args![value: value!(16)],
want: Ok(value!("local0")),
tdef: TypeDef::bytes().fallible(),
}
local1 {
args: func_args![value: value!(17)],
want: Ok(value!("local1")),
tdef: TypeDef::bytes().fallible(),
}
local2 {
args: func_args![value: value!(18)],
want: Ok(value!("local2")),
tdef: TypeDef::bytes().fallible(),
}
local3 {
args: func_args![value: value!(19)],
want: Ok(value!("local3")),
tdef: TypeDef::bytes().fallible(),
}
local4 {
args: func_args![value: value!(20)],
want: Ok(value!("local4")),
tdef: TypeDef::bytes().fallible(),
}
local5 {
args: func_args![value: value!(21)],
want: Ok(value!("local5")),
tdef: TypeDef::bytes().fallible(),
}
local6 {
args: func_args![value: value!(22)],
want: Ok(value!("local6")),
tdef: TypeDef::bytes().fallible(),
}
local7 {
args: func_args![value: value!(23)],
want: Ok(value!("local7")),
tdef: TypeDef::bytes().fallible(),
}
invalid_facility_larger_int {
args: func_args![value: value!(475)],
want: Err("facility code 475 not valid"),
tdef: TypeDef::bytes().fallible(),
}
invalid_facility_negative_int {
args: func_args![value: value!(-1)],
want: Err("facility code -1 not valid"),
tdef: TypeDef::bytes().fallible(),
}
invalid_facility_non_int {
args: func_args![value: value!("nope")],
want: Err("expected integer, got string"),
tdef: TypeDef::bytes().fallible(),
}
];
}