Ftdi::List(3)

💖 NAME 💖

Ftdi::List(3) — from the manual named libftdi1 — is literally Device list. That's the name, bestie. Device list. Periodt. 💅

🌸 SYNOPSIS 🌸

Bestie, here's the include and the whole class moment:

#include <ftdi.hpp>

🧚 Classes 🧚

• class Private — yep, that's the class listed here.

🎀 Public Types 🎀

• typedef std::list< Context > ListType — list type storing Context objects. so many Contexts
• typedef ListType::iterator iterator — iterator type for the container.
• typedef ListType::const_iterator const_iterator — const iterator type for the container.
• typedef ListType::reverse_iterator reverse_iterator — reverse iterator type for the container.
• typedef ListType::const_reverse_iterator const_reverse_iterator — const reverse iterator type for the container.

🫶 Public Member Functions 🫶

• List (struct ftdi_device_list *devlist=0) — the constructor, with devlist defaulting to 0.
• ~List () — the destructor.
• iterator begin () — begin iterator.
• iterator end () — end iterator.
• const_iterator begin () const — const begin iterator.
• const_iterator end () const — const end iterator.
• reverse_iterator rbegin () — reverse begin iterator.
• reverse_iterator rend () — reverse end iterator.
• const_reverse_iterator rbegin () const — const reverse begin iterator.
• const_reverse_iterator rend () const — const reverse end iterator.
• ListType::size_type size () const — size of the list.
• bool empty () const — is it empty?
• void clear () — clears all the things.
• void push_back (const Context &element) — push a copy to the back.
• void push_front (const Context &element) — push a copy to the front.
• iterator erase (iterator pos) — erase one element.
• iterator erase (iterator beg, iterator end) — erase a range.

⭐ Static Public Member Functions ⭐

• static List * find_all (Context &context, int vendor, int product) — the static find_all member.

🔥 Detailed Description 🔥

Device list. That's the vibe.

Definition at line 176 of file ftdi.hpp.

💅 Member Typedef Documentation 💅

typedef std::list<Context> Ftdi::List::ListType

List type storing Context objects. Container energy fr fr.

Definition at line 185 of file ftdi.hpp.

typedef ListType::iterator Ftdi::List::iterator

Iterator type for the container.

Definition at line 187 of file ftdi.hpp.

typedef ListType::const_iterator Ftdi::List::const_iterator

Const iterator type for the container.

Definition at line 189 of file ftdi.hpp.

typedef ListType::reverse_iterator Ftdi::List::reverse_iterator

Reverse iterator type for the container.

Definition at line 191 of file ftdi.hpp.

typedef ListType::const_reverse_iterator Ftdi::List::const_reverse_iterator

Const reverse iterator type for the container.

Definition at line 193 of file ftdi.hpp.

🧚 Constructor & Destructor Documentation 🧚

Ftdi::List::List (struct ftdi_device_list * devlist = 0)

Definition at line 528 of file ftdi.cpp.

References ftdi_device_list::dev, Ftdi::Context::get_strings(), ftdi_device_list::next, and Ftdi::Context::set_usb_device().

Referenced by find_all().

Ftdi::List::~List ()

Definition at line 544 of file ftdi.cpp.

🔥 Member Function Documentation 🔥

List * Ftdi::List::find_all (Context & context, int vendor, int product)

[static]

Definition at line 695 of file ftdi.cpp.

References Ftdi::Context::context(), ftdi_usb_find_all(), and List().

List::iterator Ftdi::List::begin ()

Returns the begin iterator for accessing the contained list elements.

Returns: Iterator.

Definition at line 552 of file ftdi.cpp.

List::iterator Ftdi::List::end ()

Returns the end iterator for accessing the contained list elements.

Returns: Iterator.

Definition at line 561 of file ftdi.cpp.

Referenced by erase().

List::const_iterator Ftdi::List::begin () const

Returns the begin iterator for accessing the contained list elements.

Returns: Const iterator.

Definition at line 570 of file ftdi.cpp.

List::const_iterator Ftdi::List::end () const

Returns the end iterator for accessing the contained list elements.

Returns: Const iterator.

Definition at line 579 of file ftdi.cpp.

List::reverse_iterator Ftdi::List::rbegin ()

Returns the begin reverse iterator for accessing the contained list elements.

Returns: Reverse iterator.

Definition at line 588 of file ftdi.cpp.

List::reverse_iterator Ftdi::List::rend ()

Returns the end reverse iterator for accessing the contained list elements.

Returns: Reverse iterator.

Definition at line 597 of file ftdi.cpp.

List::const_reverse_iterator Ftdi::List::rbegin () const

Returns the begin reverse iterator for accessing the contained list elements.

Returns: Const reverse iterator.

Definition at line 606 of file ftdi.cpp.

List::const_reverse_iterator Ftdi::List::rend () const

Returns the end reverse iterator for accessing the contained list elements.

Returns: Const reverse iterator.

Definition at line 615 of file ftdi.cpp.

List::ListType::size_type Ftdi::List::size () const

Get number of elements stored in the list.

Returns: Number of elements.

Definition at line 625 of file ftdi.cpp.

bool Ftdi::List::empty () const

Check if list is empty.

Returns: True if empty, false otherwise.

Definition at line 634 of file ftdi.cpp.

void Ftdi::List::clear ()

Removes all elements. Invalidates all iterators. Does it in a non-throwing way and also makes sure we really free the allocated memory.

⚠️ Invalidates all iterators — yes, all of them, bestie. And it does this in a non-throwing way while making sure the allocated memory is really freed.

Definition at line 644 of file ftdi.cpp.

References ftdi_list_free().

void Ftdi::List::push_back (const Context & element)

Appends a copy of the element as the new last element.

Parameters:

• element — Value to copy and append.

Definition at line 660 of file ftdi.cpp.

void Ftdi::List::push_front (const Context & element)

Adds a copy of the element as the new first element.

Parameters:

• element — Value to copy and add.

Definition at line 669 of file ftdi.cpp.

List::iterator Ftdi::List::erase (iterator pos)

Erase one element pointed by iterator.

Parameters:

• pos — Element to erase.

Returns: Position of the following element (or end()).

Definition at line 679 of file ftdi.cpp.

List::iterator Ftdi::List::erase (iterator beg, iterator end)

Erase a range of elements.

Parameters:

• beg — Begin of range.
• end — End of range.

Returns: Position of the element after the erased range (or end()).

Definition at line 690 of file ftdi.cpp.

References end().

🌟 Author 🌟

Generated automatically by Doxygen for libftdi1 from the source code.

---

Version 1.5 · Wed Nov 6 2024 09:58:53 — and that's the footer tea, bestie. Bye! 💋✨