Skip to content

Commit 69fd972

Browse files
authored
Move OrderMap module to root of otel-api crate (#1061)
* more OrderMap to root of the otel-api crate * missed file.. * fix lint * re export OrderMap * update changelog * reorg use
1 parent bdb777b commit 69fd972

File tree

8 files changed

+17
-12
lines changed

8 files changed

+17
-12
lines changed

opentelemetry-api/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
### Fixed
66

77
- Fix `SpanRef::set_attributes` mutability requirement. [#1038](https://github.com/open-telemetry/opentelemetry-rust/pull/1038)
8+
- Move OrderMap module to root of otel-api crate. [#1061](https://github.com/open-telemetry/opentelemetry-rust/pull/1061)
89

910
## v0.19.0
1011
### Added

opentelemetry-api/src/lib.rs

+4
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ pub use context::{Context, ContextGuard};
5151

5252
mod common;
5353

54+
mod order_map;
55+
56+
pub use order_map::OrderMap;
57+
5458
#[cfg(any(feature = "testing", test))]
5559
#[doc(hidden)]
5660
pub mod testing;
File renamed without changes.

opentelemetry-api/src/trace/mod.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,6 @@ use thiserror::Error;
169169

170170
mod context;
171171
pub mod noop;
172-
mod order_map;
173172
mod span;
174173
mod span_context;
175174
mod tracer;
@@ -179,13 +178,16 @@ pub use self::{
179178
context::{
180179
get_active_span, mark_span_as_active, FutureExt, SpanRef, TraceContextExt, WithContext,
181180
},
182-
order_map::OrderMap,
183181
span::{Span, SpanKind, Status},
184182
span_context::{SpanContext, SpanId, TraceFlags, TraceId, TraceState},
185183
tracer::{SamplingDecision, SamplingResult, SpanBuilder, Tracer},
186184
tracer_provider::TracerProvider,
187185
};
188186
use crate::{ExportError, KeyValue};
187+
use std::collections::hash_map::RandomState;
188+
189+
/// re-export OrderMap to mitigate breaking change
190+
pub type OrderMap<K, V, S = RandomState> = crate::order_map::OrderMap<K, V, S>;
189191

190192
/// Describe the result of operations in tracing API.
191193
pub type TraceResult<T> = Result<T, TraceError>;

opentelemetry-api/src/trace/tracer.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
use crate::trace::OrderMap;
21
use crate::{
32
trace::{Event, Link, Span, SpanId, SpanKind, Status, TraceContextExt, TraceId, TraceState},
4-
Context, Key, KeyValue, Value,
3+
Context, Key, KeyValue, OrderMap, Value,
54
};
65
use std::borrow::Cow;
76
use std::iter::FromIterator;

opentelemetry-sdk/src/trace/sampler.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
use opentelemetry_api::trace::OrderMap;
21
use opentelemetry_api::{
32
trace::{
43
Link, SamplingDecision, SamplingResult, SpanKind, TraceContextExt, TraceId, TraceState,
54
},
6-
Context, Key, Value,
5+
Context, Key, OrderMap, Value,
76
};
87
use std::convert::TryInto;
98

opentelemetry-sdk/src/trace/sampler/jaeger_remote/sampler.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ use crate::trace::sampler::jaeger_remote::sampling_strategy::Inner;
33
use crate::trace::{Sampler, ShouldSample, TraceRuntime};
44
use futures_util::{stream, StreamExt as _};
55
use http::Uri;
6-
use opentelemetry_api::trace::{Link, OrderMap, SamplingResult, SpanKind, TraceError, TraceId};
7-
use opentelemetry_api::{global, Context, Key, Value};
6+
use opentelemetry_api::trace::{Link, SamplingResult, SpanKind, TraceError, TraceId};
7+
use opentelemetry_api::{global, Context, Key, OrderMap, Value};
88
use opentelemetry_http::HttpClient;
99
use std::str::FromStr;
1010
use std::sync::Arc;

opentelemetry-sdk/src/trace/tracer.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ use crate::{
1717
InstrumentationLibrary,
1818
};
1919
use opentelemetry_api::trace::{
20-
Link, OrderMap, SamplingDecision, SamplingResult, SpanBuilder, SpanContext, SpanId, SpanKind,
20+
Link, SamplingDecision, SamplingResult, SpanBuilder, SpanContext, SpanId, SpanKind,
2121
TraceContextExt, TraceFlags, TraceId, TraceState,
2222
};
23-
use opentelemetry_api::{Context, Key, KeyValue, Value};
23+
use opentelemetry_api::{Context, Key, KeyValue, OrderMap, Value};
2424
use std::fmt;
2525
use std::sync::Weak;
2626

@@ -276,10 +276,10 @@ mod tests {
276276
};
277277
use opentelemetry_api::{
278278
trace::{
279-
Link, OrderMap, SamplingDecision, SamplingResult, Span, SpanContext, SpanId, SpanKind,
279+
Link, SamplingDecision, SamplingResult, Span, SpanContext, SpanId, SpanKind,
280280
TraceContextExt, TraceFlags, TraceId, TraceState, Tracer, TracerProvider,
281281
},
282-
Context, Key, Value,
282+
Context, Key, OrderMap, Value,
283283
};
284284

285285
#[derive(Clone, Debug)]

0 commit comments

Comments
 (0)