rustfs_targets/
lib.rs

1// Copyright 2024 RustFS 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
15pub mod arn;
16pub mod catalog;
17mod check;
18pub mod config;
19pub mod control_plane;
20pub mod domain;
21pub mod error;
22pub mod manifest;
23mod net;
24pub mod plugin;
25pub mod runtime;
26pub mod store;
27pub mod sys;
28pub mod target;
29#[cfg(any(test, feature = "test-support"))]
30pub mod testkit;
31
32pub use catalog::extension::{
33    OPS_DIAGNOSTICS_EXTENSION_API_VERSION, OPS_PROFILER_EXTENSION_API_VERSION, S3_HOOK_EXTENSION_API_VERSION,
34    TARGET_AUDIT_CAPABILITY, TARGET_NOTIFY_CAPABILITY, builtin_extension_schemas, builtin_ops_diagnostics_contract,
35    builtin_ops_diagnostics_extension_schema, builtin_ops_profiler_contract, builtin_ops_profiler_extension_schema,
36    builtin_s3_hook_contract, builtin_s3_hook_extension_schema, builtin_target_extension_schemas,
37    target_marketplace_extension_schema, target_runtime_boundary,
38};
39pub use check::{
40    check_amqp_broker_available, check_kafka_broker_available, check_mqtt_broker_available, check_mqtt_broker_available_with_tls,
41    check_mysql_server_available, check_nats_server_available, check_postgres_server_available, check_pulsar_broker_available,
42    check_redis_server_available,
43};
44pub use config::{
45    LegacyTargetInstanceDescriptor, TargetInstanceSourceClass, TargetInstanceSourceHints, TargetPluginInstance,
46    TargetPluginInstanceCompatDescriptor, TargetPluginInstanceRecord, normalize_legacy_target_instances,
47    normalize_legacy_target_instances_from_env, normalize_target_plugin_instances, normalize_target_plugin_instances_from_env,
48    try_normalize_target_plugin_instances, try_normalize_target_plugin_instances_from_env,
49};
50pub use control_plane::{
51    TargetPluginEnableState, TargetPluginExternalAction, TargetPluginExternalActionDecision, TargetPluginExternalActionError,
52    TargetPluginExternalFlowGate, TargetPluginExternalFlowGateStatus, TargetPluginInstallState, TargetPluginInstallation,
53    TargetPluginOperationalState, TargetPluginRevision, TargetPluginRuntimeState, builtin_target_plugin_installation,
54    builtin_target_plugin_operational_state, external_target_plugin_installation, plan_external_target_plugin_action,
55    rollback_target_plugin_installation, runtime_state_from_status_label,
56};
57pub use domain::TargetDomain;
58pub use error::{StoreError, TargetError};
59pub use manifest::{
60    SUPPORTED_PLUGIN_API_COMPATIBILITY_VERSION, TargetPluginArtifactManifest, TargetPluginDistributionManifest,
61    TargetPluginEntrypointKind, TargetPluginExternalRuntimeContract, TargetPluginManifest, TargetPluginMarketplaceManifest,
62    TargetPluginPackaging, TargetPluginRuntimeTransport, builtin_target_marketplace_manifest,
63    installable_target_marketplace_manifest,
64};
65pub use net::*;
66pub use plugin::{
67    BuiltinTargetAdminDescriptor, BuiltinTargetDescriptor, PluginEvent, TargetAdminMetadata, TargetPluginDescriptor,
68    TargetPluginRegistry, TargetRequestValidator, boxed_target,
69};
70pub use runtime::{
71    OpenedActivation, PreparedActivation, ReplayEvent, ReplayWorkerManager, RuntimeActivation, RuntimeStatusSnapshot,
72    RuntimeTargetHealthReason, RuntimeTargetHealthSnapshot, RuntimeTargetHealthState, RuntimeTargetSnapshot, SharedTarget,
73    TargetRuntimeManager, activate_targets_with_replay,
74    adapter::{BuiltinPluginRuntimeAdapter, PluginRuntimeAdapter},
75    health_snapshots_for_targets, init_target_and_optionally_start_replay,
76    ops_diagnostics::{
77        OpsDiagnosticsAccessDecision, OpsDiagnosticsReadRequest, OpsDiagnosticsRegistration, OpsDiagnosticsRegistry,
78        OpsDiagnosticsRegistryError,
79    },
80    ops_profiler::{
81        OpsProfilerAccessDecision, OpsProfilerReadRequest, OpsProfilerRegistration, OpsProfilerRegistry, OpsProfilerRegistryError,
82    },
83    s3_hooks::{S3HookContext, S3HookDecision, S3HookDispatchOutcome, S3HookRegistration, S3HookRegistry, S3HookRegistryError},
84    sidecar::{SidecarPluginRuntime, SidecarRuntimePolicy, SidecarRuntimePolicyError, SidecarRuntimeSafetyChecks},
85    sidecar_protocol::{SIDECAR_RUNTIME_PROTOCOL_VERSION, SidecarHandshake, SidecarPluginCapability},
86    start_replay_worker,
87};
88pub use rustfs_s3_types::EventName;
89use serde::{Deserialize, Serialize};
90pub use sys::user_agent::*;
91pub use target::{Target, TargetDeliverySnapshot};
92pub use target::{TargetHealth, TargetHealthReason, TargetHealthState};
93
94/// Represents a log of events for sending to targets
95#[derive(Debug, Clone, Serialize, Deserialize)]
96#[serde(rename_all = "PascalCase")]
97pub struct TargetLog<E> {
98    /// The event name
99    pub event_name: EventName,
100    /// The object key
101    pub key: String,
102    /// The list of events
103    pub records: Vec<E>,
104}
rustfs_targets/lib.rs

rustfs_targets/
lib.rs
