:right-sidebar: True

String
===================================================================

.. currentmodule:: gi.repository.GObject





.. class:: String(*args, **kwargs)
   :no-contents-entry:






:Constructors:

::

    String()
    new(init:str=None) -> GLib.String
    new_len(init:str, len:int) -> GLib.String
    new_take(init:str=None) -> GLib.String
    sized_new(dfl_size:int) -> GLib.String



Constructors
------------

.. rst-class:: interim-class

.. class:: String
   :no-index:


   .. classmethod:: new(init: str | None = None) -> ~gi.repository.GLib.String

      






      :param init: 




   .. classmethod:: new_len(init: str, len: int) -> ~gi.repository.GLib.String

      






      :param init: 

      :param len: 




   .. classmethod:: new_take(init: str | None = None) -> ~gi.repository.GLib.String

      






      :param init: 




   .. classmethod:: sized_new(dfl_size: int) -> ~gi.repository.GLib.String

      






      :param dfl_size: 








Methods
-------

.. rst-class:: interim-class

.. class:: String
   :no-index:


   .. method:: append(val: str) -> ~gi.repository.GLib.String

      






      :param val: 




   .. method:: append_c(c: int) -> ~gi.repository.GLib.String

      






      :param c: 




   .. method:: append_len(val: str, len: int) -> ~gi.repository.GLib.String

      






      :param val: 

      :param len: 




   .. method:: append_unichar(wc: str) -> ~gi.repository.GLib.String

      






      :param wc: 




   .. method:: append_uri_escaped(unescaped: str, reserved_chars_allowed: str, allow_utf8: bool) -> ~gi.repository.GLib.String

      






      :param unescaped: 

      :param reserved_chars_allowed: 

      :param allow_utf8: 




   .. method:: ascii_down() -> ~gi.repository.GLib.String

      









   .. method:: ascii_up() -> ~gi.repository.GLib.String

      









   .. method:: assign(rval: str) -> ~gi.repository.GLib.String

      






      :param rval: 




   .. method:: down() -> ~gi.repository.GLib.String

      









   .. method:: equal(v2: ~gi.repository.GLib.String) -> bool

      






      :param v2: 




   .. method:: erase(pos: int, len: int) -> ~gi.repository.GLib.String

      






      :param pos: 

      :param len: 




   .. method:: free(free_segment: bool) -> str | None

      






      :param free_segment: 




   .. method:: free_to_bytes() -> ~gi.repository.GLib.Bytes

      









   .. method:: hash() -> int

      









   .. method:: insert(pos: int, val: str) -> ~gi.repository.GLib.String

      






      :param pos: 

      :param val: 




   .. method:: insert_c(pos: int, c: int) -> ~gi.repository.GLib.String

      






      :param pos: 

      :param c: 




   .. method:: insert_len(pos: int, val: str, len: int) -> ~gi.repository.GLib.String

      






      :param pos: 

      :param val: 

      :param len: 




   .. method:: insert_unichar(pos: int, wc: str) -> ~gi.repository.GLib.String

      






      :param pos: 

      :param wc: 




   .. method:: overwrite(pos: int, val: str) -> ~gi.repository.GLib.String

      






      :param pos: 

      :param val: 




   .. method:: overwrite_len(pos: int, val: str, len: int) -> ~gi.repository.GLib.String

      






      :param pos: 

      :param val: 

      :param len: 




   .. method:: prepend(val: str) -> ~gi.repository.GLib.String

      






      :param val: 




   .. method:: prepend_c(c: int) -> ~gi.repository.GLib.String

      






      :param c: 




   .. method:: prepend_len(val: str, len: int) -> ~gi.repository.GLib.String

      






      :param val: 

      :param len: 




   .. method:: prepend_unichar(wc: str) -> ~gi.repository.GLib.String

      






      :param wc: 




   .. method:: replace(find: str, replace: str, limit: int) -> int

      






      :param find: 

      :param replace: 

      :param limit: 




   .. method:: set_size(len: int) -> ~gi.repository.GLib.String

      






      :param len: 




   .. method:: truncate(len: int) -> ~gi.repository.GLib.String

      






      :param len: 




   .. method:: up() -> ~gi.repository.GLib.String

      



















Fields
------

.. rst-class:: interim-class

.. class:: String
   :no-index:
   

   .. attribute:: allocated_len

      






   .. attribute:: len

      






   .. attribute:: str