common_procedure/lib.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
15//! Common traits and structures for the procedure framework.
16
17pub mod error;
18pub mod event;
19pub mod local;
20pub mod options;
21mod procedure;
22pub mod rwlock;
23pub mod store;
24pub mod watcher;
25
26#[cfg(any(test, feature = "testing"))]
27pub mod test_util;
28
29pub use crate::error::{Error, Result};
30pub use crate::event::ProcedureEvent;
31pub use crate::procedure::{
32 BoxedProcedure, BoxedProcedureLoader, Context, ContextProvider, ContextProviderRef, LockKey,
33 Output, ParseIdError, PoisonKey, PoisonKeys, Procedure, ProcedureId, ProcedureInfo,
34 ProcedureManager, ProcedureManagerRef, ProcedureState, ProcedureWithId, Status, StringKey,
35 UserMetadata,
36};
37pub use crate::watcher::Watcher;