Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guide/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Types are defined under `<types>` and associated with topics. Example:

You can define types in IDL and convert them to XML with `rtiddsgen`:

```
```plain
rtiddsgen -convertToXml MyTypes.idl
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This is the typical flow for using Connector: create a connector,
obtain an output and input, write one sample, then read samples back. For
example:

```rust
```rust,no_run
use rtiddsconnector::{Connector, GlobalsDropGuard, Input, Output};

fn main() -> rtiddsconnector::ConnectorFallible {
Expand Down
10 changes: 5 additions & 5 deletions docs/guide/input.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ fn get_input(connector: &Connector) -> rtiddsconnector::ConnectorResult<Input<'_

Call [`crate::Input::take`] to access and remove samples:

```rust
```rust,compile_fail
input.take()?;
```

Or call [`crate::Input::read`] to access samples but leave them available for a
future `read` or `take`:

```rust
```rust,compile_fail
input.read()?;
```

Expand All @@ -44,7 +44,7 @@ samples; call `read` or `take` afterward.
After calling [`crate::Input::read`] or [`crate::Input::take`], iterate over the
samples:

```rust
```rust,compile_fail
for sample in input.into_iter() {
if sample.is_valid()? {
println!("{}", sample);
Expand All @@ -54,7 +54,7 @@ for sample in input.into_iter() {

To skip invalid samples, use `valid_only()`:

```rust
```rust,compile_fail
for sample in input.into_iter().valid_only() {
println!("{}", sample);
}
Expand Down Expand Up @@ -83,7 +83,7 @@ resources sooner.
Every sample contains an associated SampleInfo with meta-data about the
sample:

```rust
```rust,compile_fail
for sample in input.into_iter() {
let source_timestamp = sample.get_info("source_timestamp")?;
println!("source_timestamp: {:?}", source_timestamp);
Expand Down
1 change: 0 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,3 @@ pub mod guide {
))]
}
}