stumpless-sys 0.3.0

Bindings for the Stumpless logging library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

// SPDX-License-Identifier: Apache-2.0

// Copyright 2023 Joel E. Anderson
//
// 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.

//! FFI bindings for the Stumpless logging library.
//!
//! These wrappings are intended to be the bare minimum to use Stumpless from
//! a Rust application.
//!
//!
//! # Create Features
//! Stumpless provides a number of build configuration options that can be used
//! to enable or disable different functionality. This crate exposes these
//! options as the following features.
//!
//!
//! ### Target Features
//!
//! * **journald** -
//!   Enables targets that can send logs to a systemd journald daemon.
//! * **network** -
//!   Enables targets that can send logs to a server over a network connection.
//! * **socket** -
//!   Enables targets that can send logs to Unix sockets.
//! * **wel** -
//!   Enables targets that can send logs to the Windows Event Log.

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]

include!(concat!(env!("OUT_DIR"), "/bindings.rs"));

#[cfg(feature = "wel")]
use std::fs::File;
#[cfg(feature = "wel")]
use std::io::Write;
#[cfg(feature = "wel")]
use std::path::Path;

/// Writes a compiled resource file (.bin) to the provided file.
#[cfg(feature = "wel")]
pub fn write_default_events_bin_file<P: AsRef<Path>>(path: &P) -> std::io::Result<()> {
    let resource_bytes = include_bytes!(env!("STUMPLESS_DEFAULT_EVENTS_BIN_PATH"));
    let mut file = File::create(&path)?;
    file.write_all(resource_bytes)
        .expect("couldn't write to the file!");
    Ok(())
}

/// Writes the resource definition (.rc) file for the default Stumpless events
/// to the provided file.
#[cfg(feature = "wel")]
pub fn write_default_events_resource_file<P: AsRef<Path>>(path: &P) -> std::io::Result<()> {
    let resource_bytes = include_bytes!(env!("STUMPLESS_DEFAULT_EVENTS_RC_PATH"));
    let mut file = File::create(&path)?;
    file.write_all(resource_bytes)
        .expect("couldn't write to the file!");
    Ok(())
}