Skip to content
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.

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

A minimal std::expected<T, E> #12

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
BasedOnStyle: Google
---
Language: Cpp
DerivePointerAlignment: false
PointerAlignment: Left
30 changes: 30 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
cmake_minimum_required(VERSION 3.13)

enable_testing()
find_package(GTest MODULE REQUIRED)

# Include directories accessible from here.
include_directories(.)

# Require C++17 with no extensions.
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)

# Add the test to the std::expected implementation.
add_executable(expected_test netlib/expected_test.cc)
target_link_libraries(expected_test PRIVATE GTest::GTest GTest::Main)
add_test(expected_test expected_test)
29 changes: 29 additions & 0 deletions netlib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# netlib Directory

This is the main source directory for the project. The intent is to keep this
directory flat with subdirectories for logical groupings. This means all the
headers, implementation, and test code should be co-hosted in this directory.

## Structure

All implementation files must end with the `.cc` filename extension, and all
headers must end in `.h`. If we have a file named `connection.cc` the header
must be `connection.h` and the test(s) should be in `connection_test.cc`.

We shall control the installed headers through our CMake configuration
instead of assuming that all headers are publicly accessible. When including
files, we should always include headers in the netlib repository by relative
inclusion with the `netlib/` directory (based off the root of the
repository). As an example:

```c++
// In connection.cc and connection_test.cc.
#include "netlib/connection.h"
```

## Subdirectories

We can introduce subdirectories for logical grouping, each one following the
same structure rules as described here. For instance, if we have a
subdirectory of encoding/decoding, we can introduce a `coding/` subdirectory
with all the encoders and decoders implemented.
Loading