package json

import (
	"realy.lol/chk"
	"realy.lol/text"
)

// String is a regular string. Must be escaped as per nip-01. Bytes stored in it are not
// escaped, only must be escaped to output JSON.
//
// Again like the other types, create a new String with:
//
//	str := json.String{}
//
// There is also a convenience NewString function that generically automatically converts actual
// golang strings to save the caller from doing so.
type String struct{ V []byte }

// NewString creates a new String from a string or byte string.
func NewString[V ~string | ~[]byte](s V) *String { return &String{[]byte(s)} }

// Marshal a String into a quoted byte string.
func (s *String) Marshal(dst []byte) (b []byte) {
	b = text.AppendQuote(dst, s.V, text.NostrEscape)
	return
}

// Unmarshal from a quoted JSON string into a String.
func (s *String) Unmarshal(dst []byte) (rem []byte, err error) {
	var c []byte
	if c, rem, err = text.UnmarshalQuoted(dst); chk.E(err) {
		return
	}
	s.V = c
	return
}