Skip to content

docs: add variable matching example to subset_of matcher #830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Raushan-tryingtocode wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add variable matching example to subset_of matcher #830

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions googletest/src/matchers/subset_of_matcher.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,22 @@ use std::fmt::Debug;
/// # should_pass().unwrap();
/// ```
///
/// Using variables of standard library collections requires matching item
/// reference types:
///
/// ```
/// # use googletest::prelude::*;
/// # fn should_pass() -> Result<()> {
/// let set_x = vec![1, 2, 3];
/// let set_y = vec![2, 3];
///
/// // Borrow the elements of the expected container to match reference types
/// let expected: Vec<&i32> = set_x.iter().collect();
/// verify_that!(set_y, subset_of(expected))?;
/// # Ok(())
/// # }
/// # should_pass().unwrap();
/// ```
/// A note on performance: This matcher uses a naive algorithm with a worst-case
/// runtime proportional to the *product* of the sizes of the actual and
/// expected containers as well as the time to check equality of each pair of
Expand Down