Skip to content

Commit

Permalink
Allow for generically extracting unannotated str
Browse files Browse the repository at this point in the history
As raised by Alexander Plavin, you may want to obtain a the underlying
string of an AnnotatedString in non-String cases. However, there's no
public API for doing so. Instead of just implementing this functionality
for the String type, we can make it more generic.

Co-authored-by: Jameson Nash <vtjnash@gmail.com>
  • Loading branch information
tecosaur and vtjnash committed Aug 11, 2024
1 parent 2e1235e commit 162e37a
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions base/strings/annotated.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ A string with metadata, in the form of annotated regions.
More specifically, this is a simple wrapper around any other
[`AbstractString`](@ref) that allows for regions of the wrapped string to be
annotated with labeled values.
annotated with labelled values. The underlying string can be extracted by
calling a string constructor with the `AnnotatedString` as the argument.
```text
C
Expand Down Expand Up @@ -125,7 +126,10 @@ AnnotatedString(s::AnnotatedString, annots::Vector{Tuple{UnitRange{Int}, Pair{Sy
AnnotatedChar(c::AnnotatedChar, annots::Vector{Pair{Symbol, Any}}) =
AnnotatedChar(c.char, vcat(c.annotations, annots))

String(s::AnnotatedString{String}) = s.string # To avoid pointless overhead
# To allow for generically de-annotating a string.
(::Type{T})(s::AnnotatedString) where {T <: AbstractString} = T(s.string)
String(s::AnnotatedString{String}) = s.string # To avoid pointless overhead (and avoid ambiguity)
AnnotatedString(s::AnnotatedString) = s # To resolve an ambiguity

## Conversion/promotion ##

Expand Down

0 comments on commit 162e37a

Please sign in to comment.