vector_core/
lib.rs

1//! The Vector Core Library
2//!
3//! The Vector Core Library are the foundational pieces needed to make a vector
4//! and is not vector with pieces missing. While this library is obviously
5//! tailored to the needs of vector it is written in such a way to make
6//! experimentation and testing _in the library_ cheap and demonstrative.
7//!
8//! This library was extracted from the top-level project package, discussed in
9//! RFC 7027.
10
11#![deny(warnings)]
12#![deny(clippy::all)]
13#![deny(clippy::pedantic)]
14#![deny(unreachable_pub)]
15#![deny(unused_allocation)]
16#![deny(unused_extern_crates)]
17#![deny(unused_assignments)]
18#![deny(unused_comparisons)]
19#![allow(clippy::cast_possible_wrap)]
20#![allow(clippy::cast_sign_loss)]
21#![allow(clippy::default_trait_access)] // triggers on generated prost code
22#![allow(clippy::float_cmp)]
23#![allow(clippy::match_wildcard_for_single_variants)]
24#![allow(clippy::module_name_repetitions)]
25#![allow(clippy::must_use_candidate)] // many false positives in this package
26#![allow(clippy::non_ascii_literal)] // using unicode literals is a-okay in vector
27#![allow(clippy::unnested_or_patterns)] // nightly-only feature as of 1.51.0
28#![allow(clippy::type_complexity)] // long-types happen, especially in async code
29
30pub mod config;
31pub mod event;
32pub mod fanout;
33pub mod ipallowlist;
34pub mod latency;
35pub mod metrics;
36pub mod partition;
37pub mod schema;
38pub mod serde;
39pub mod sink;
40pub mod source;
41pub mod source_sender;
42pub mod tcp;
43#[cfg(test)]
44mod test_util;
45pub mod time;
46pub mod tls;
47pub mod transform;
48#[cfg(feature = "vrl")]
49pub mod vrl;
50
51use std::path::PathBuf;
52
53pub use event::EstimatedJsonEncodedSizeOf;
54use float_eq::FloatEq;
55
56#[cfg(feature = "vrl")]
57pub use crate::vrl::compile_vrl;
58
59#[macro_use]
60extern crate tracing;
61
62pub fn default_data_dir() -> Option<PathBuf> {
63    Some(PathBuf::from("/var/lib/vector/"))
64}
65
66pub(crate) use vector_common::{Error, Result};
67
68pub(crate) fn float_eq(l_value: f64, r_value: f64) -> bool {
69    (l_value.is_nan() && r_value.is_nan()) || l_value.eq_ulps(&r_value, &1)
70}
71
72// These macros aren't actually usable in lib crates without some `vector_lib` shenanigans.
73#[macro_export]
74macro_rules! emit {
75    ($event:expr) => {
76        vector_lib::internal_event::emit($event)
77    };
78}
79
80#[macro_export]
81macro_rules! register {
82    ($event:expr) => {
83        vector_lib::internal_event::register($event)
84    };
85}
vector_core/lib.rs

vector_core/
lib.rs
