.TH "ZyanStringView_" 3 "Version 1.5.0.0" "Zycore" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ZyanStringView_
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <String\&.h>\fP
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBZyanString\fP \fBstring\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Defines the \fCZyanStringView\fP struct\&.
.PP
The \fCZyanStringView\fP type provides a view inside a string (\fCZyanString\fP instances, null- terminated C-style strings, or even not-null-terminated custom strings)\&. A view is immutable by design and can't be directly converted to a C-style string\&.
.PP
Views might become invalid (e\&.g\&. pointing to invalid memory), if the underlying string gets destroyed or resized\&.
.PP
The \fCZYAN_STRING_TO_VIEW\fP macro can be used to cast a \fCZyanString\fP to a \fCZyanStringView\fP pointer without any runtime overhead\&. Casting a view to a normal string is not supported and will lead to unexpected behavior (use \fCZyanStringDuplicate\fP to create a deep-copy instead)\&.
.PP
All fields in this struct should be considered as 'private'\&. Any changes may lead to unexpected behavior\&. 
.SH "Member Data Documentation"
.PP 
.SS "\fBZyanString\fP ZyanStringView_::string"
The string data\&.
.PP
The view internally re-uses the normal string struct to allow casts without any runtime overhead\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Zycore from the source code\&.