Skip to content
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.

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

Interface::run returns a Cow<'a> #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

seb-bl
Copy link

@seb-bl seb-bl commented May 10, 2020

I recently used this crate as a lib for a personal project, and I really appreciated it!

I once tried to simply call Interface::new(&stuff).run() and got errors with lifetime. Looking further I found out that the result of run is not a reference with the lifetime of stuff, because it may return a reference to the search string.

So I changed the return type of run and the function result to take the search string in the case of no matches. This allows dropping Interface and keep the result.

This is a breaking change to the API, as the return type and lifetime are changed, and run now clear the search string if it did not match.

Changed `Interface::run` to return a `Cow` with the lifetime of the borrowed slice of strings. 

The `Owned` case occurs when the search does not match anything. In that case, the search string is taken out of the `Interface` and replaced by an empty string.

Using a `Cow` with the lifetime of the given strings allows to drop the `Interface` struct after a run, without needing to clone the returned `&str` to keep the result. It also allows the caller to know whether the result is from the given list, or comes from a search that had no match.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant