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.

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

Jump to bottom

Add DataAPI.unwrap with default definition #35

Merged
merged 2 commits into from
Feb 14, 2021
Merged

Add DataAPI.unwrap with default definition #35

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d173345
Add DataAPI.unwrap with default definition
quinnj Feb 14, 2021
a4576dc
Bump version
quinnj Feb 14, 2021
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
14 changes: 14 additions & 0 deletions src/DataAPI.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,18 @@ struct Cols{T<:Tuple}
Cols(args...) = new{typeof(args)}(args)
end

"""
unwrap(x)

For a given scalar argument `x`, potentially "unwrap" it to return the base wrapped value.
Useful as a generic API for wrapper types when the original value is needed.

The default definition just returns `x` itself, i.e. no unwrapping is performned.

This generic function is owned by DataAPI.jl itself, which is the sole provider of the
default definition.
"""
function unwrap end
unwrap(x) = x

end # module
5 changes: 5 additions & 0 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,9 @@ end

end

@testset "unwrap" begin
@test DataAPI.unwrap(1) === 1
@test DataAPI.unwrap(missing) === missing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, clever: with that fallback we don't need to use passmissing(unwrap)!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes!

end

end # @testset "DataAPI"