Skip to content

Document Crystal::Macros::StringLiteral#to_utf16 #15748

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

Merged
straight-shoota merged 1 commit into from
May 8, 2025
Merged

Document Crystal::Macros::StringLiteral#to_utf16 #15748

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
14 changes: 14 additions & 0 deletions src/compiler/crystal/macros.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,20 @@ private macro def_string_methods(klass)
def to_i(base = 10)
end

# Returns an expression that evaluates to a slice literal containing the
# UTF-16 code units of this string, plus an extra trailing null character.
# This null character is not part of the slice, but ensures that calling
# `#to_unsafe` always results in a properly null-terminated C string.
#
# ```
# {{ "abc😂".to_utf16 }} # => ::Slice(::UInt16).literal(97, 98, 99, 55357, 56834, 0)[0, 5]
# ```
#
# WARNING: The return value is not necessarily a literal node.
@[Experimental("Slice literals are still under development. Join the discussion at [#2886](https://github.com/crystal-lang/crystal/issues/2886).")]
def to_utf16 : ASTNode
end

# Similar to `String#tr`.
def tr(from : StringLiteral, to : StringLiteral) : {{klass}}
end
Expand Down